A library for handling GADGET-2 snapshot files.
For developing Gadget-Tools, we recommend using conda as a manager for virtual environments. A minimal installer for conda is available at the miniconda site. Also, we recommend using poetry as the packaging and dependency manager (see here for poetry installation instructions).
After installing conda, we must create an isolated, suitable python environment.
For instance, to create and activate an environment named gadget-tools-py37
with Python 3.7 installed, we can use the following instructions:
conda create -n gadget-tools-py37 python=3.7
conda activate gadget-tools-py37Once the virtual environment becomes active, we must install the dependencies of
our project. These dependencies reside in the pyproject.toml file located at
the project root directory. Since Poetry takes care of dependency management, we
go to the project root directory and type the following:
poetry installNext, Poetry takes care of downloading and installing all the dependencies of our project. Also, it installs our project as a package in the current environment so that it can be imported correctly from other scripts.
The library source files belong to the src/ directory. The main package
is gadget_tools.
- Mariana Jaber
- Omar Abel Rodríguez-López
Copyright, 2020, Gadget-Tools Authors. Code released under the Apache License Version 2.0.