Repository for the AMoKI remote-sensing project.
To set up the project on your local machine, follow these steps:
-
Clone the Repository (assuming you are using ssh)
git clone git@git.dida.do:dida/amoki.git cd amoki -
Install Poetry
Poetry is used for dependency management. If you don't have Poetry installed, you can install it by following the instructions here.
-
Install dependencies
poetry install
-
Activate the virtual environment
poetry shell
You are now ready to start working with the project. For any issues, refer to the docs directory or contact the project maintainers.
To add dependency X, use
poetry add Xor manually add it to the pyproject.toml file. To remove a dependency, use:
poetry remove XIf you wish to reinstall all the dependencies of the project, use:
poetry install├── amoki <- Source code for use in this project.
│ │
│ ├── __init__.py <- Makes amoki into a Python module
| ├── utilities
| | └── sentinelhub_utils.py
│ └── config.py <- Configuration file for the project
│
├── data
│ ├── external <- Data from third party sources.
│ ├── interim <- Intermediate data that has been transformed.
│ ├── processed <- The final, canonical data sets for modelling.
│ └── raw <- The original, immutable data dump.
│
├── notebooks <- Jupyter notebooks
│
├── references <- Data dictionaries, manuals, and all other explanatory materials.
│
├── .gitignore
├── LICENSE <- Open-source license if one is chosen
├── poetry.lock <- Locked package versions
├── pyproject.toml <- Project configuration file with package metadata for amoki
│ dependencies, and configuration for tools like black
└── README.md <- The top-level README for developers using this project.
To access Sentinel Hub services, you require an account. More details can be found at SentinelHub.