Welcome to sostrades-dev-tools documentation!
Note
This project is under active development.
Objective
The objective of this repository is to provide scripts to easily set up a working local environment. It contains script facilities to clone repositories, and create virtual environments (using conda) for sostrades project.
The scripts clone the repositories in the correct folder for the rest of the scripts to work properly, as explained in Installation section. The expected folder organisation is the following :
├── sostrades-dev-tools
│ ├── dockers
│ │ └── docker related files
│ ├── models
│ │ ├── witness-core
│ │ ├── witness-energy
│ │ └── Other model repositories
│ ├── platform
│ │ ├── gemseo
│ │ ├── sostrades-core
│ │ ├── sostrades-webapi
│ │ ├── sostrades-webgui
│ │ └── sostrades-ontology
└── other files...
You are then free to change branches, pull changes, clone new model repositories and use scripts at your convenience.
Contents
- Installation
- 1. Choose your installation
- 2. Common Setup
- 3. Local Docker Env Installation
- 4. Scripted Windows installation
- 5. Mac OS Installation
- 6. Linux Installation
- 7. Local Model Development Env Installation
- Add personal repository