Add detailed SQLAlchemy models, navigation metadata, enumerations, Pydantic schemas, monitoring, and auditing documentation
- Introduced SQLAlchemy models for user management, project management, financial inputs, and pricing configuration. - Created navigation metadata tables for sidebar and top-level menus. - Cataloged enumerations used across ORM models and Pydantic schemas. - Documented Pydantic schemas for API request/response validation, including authentication, project, scenario, import, and export schemas. - Added monitoring and auditing tables for performance metrics and import/export logs. - Updated security documentation to reflect changes in data model references.
This commit is contained in:
83
architecture/08_concepts/02_data_model/03_enumerations.md
Normal file
83
architecture/08_concepts/02_data_model/03_enumerations.md
Normal file
@@ -0,0 +1,83 @@
|
||||
# Enumerations
|
||||
|
||||
This page catalogs the enumerations shared by Calminer ORM models and Pydantic schemas. The entries mirror the original content from `02_data_model.md` so enum updates can be maintained independently of the broader data model reference.
|
||||
|
||||
## MiningOperationType
|
||||
|
||||
Supported mining operation categories.
|
||||
|
||||
- `OPEN_PIT`: Open pit mining
|
||||
- `UNDERGROUND`: Underground mining
|
||||
- `IN_SITU_LEACH`: In-situ leaching
|
||||
- `PLACER`: Placer mining
|
||||
- `QUARRY`: Quarry operations
|
||||
- `MOUNTAINTOP_REMOVAL`: Mountaintop removal
|
||||
- `OTHER`: Other operations
|
||||
|
||||
## ScenarioStatus
|
||||
|
||||
Lifecycle states for project scenarios.
|
||||
|
||||
- `DRAFT`: Draft status
|
||||
- `ACTIVE`: Active status
|
||||
- `ARCHIVED`: Archived status
|
||||
|
||||
## FinancialCategory
|
||||
|
||||
Enumeration of cost and revenue classifications.
|
||||
|
||||
- `CAPITAL_EXPENDITURE`: Capital expenditures
|
||||
- `OPERATING_EXPENDITURE`: Operating expenditures
|
||||
- `REVENUE`: Revenue
|
||||
- `CONTINGENCY`: Contingency
|
||||
- `OTHER`: Other
|
||||
|
||||
## DistributionType
|
||||
|
||||
Supported stochastic distribution families for simulations.
|
||||
|
||||
- `NORMAL`: Normal distribution
|
||||
- `TRIANGULAR`: Triangular distribution
|
||||
- `UNIFORM`: Uniform distribution
|
||||
- `LOGNORMAL`: Lognormal distribution
|
||||
- `CUSTOM`: Custom distribution
|
||||
|
||||
## ResourceType
|
||||
|
||||
Primary consumables and resources used in mining operations.
|
||||
|
||||
- `DIESEL`: Diesel fuel
|
||||
- `ELECTRICITY`: Electrical power
|
||||
- `WATER`: Process water
|
||||
- `EXPLOSIVES`: Blasting agents
|
||||
- `REAGENTS`: Processing reagents
|
||||
- `LABOR`: Direct labor
|
||||
- `EQUIPMENT_HOURS`: Equipment operating hours
|
||||
- `TAILINGS_CAPACITY`: Tailings storage
|
||||
|
||||
## CostBucket
|
||||
|
||||
Granular cost buckets aligned with project accounting.
|
||||
|
||||
- `CAPITAL_INITIAL`: Initial capital
|
||||
- `CAPITAL_SUSTAINING`: Sustaining capital
|
||||
- `OPERATING_FIXED`: Fixed operating costs
|
||||
- `OPERATING_VARIABLE`: Variable operating costs
|
||||
- `MAINTENANCE`: Maintenance costs
|
||||
- `RECLAMATION`: Reclamation costs
|
||||
- `ROYALTIES`: Royalties
|
||||
- `GENERAL_ADMIN`: General and administrative
|
||||
|
||||
## StochasticVariable
|
||||
|
||||
Domain variables that typically require probabilistic modelling.
|
||||
|
||||
- `ORE_GRADE`: Ore grade variability
|
||||
- `RECOVERY_RATE`: Metallurgical recovery
|
||||
- `METAL_PRICE`: Commodity price
|
||||
- `OPERATING_COST`: Operating cost per tonne
|
||||
- `CAPITAL_COST`: Capital cost
|
||||
- `DISCOUNT_RATE`: Discount rate
|
||||
- `THROUGHPUT`: Plant throughput
|
||||
|
||||
Refer back to the [data model overview](../02_data_model.md) when choosing the appropriate enum for new features.
|
||||
Reference in New Issue
Block a user