The DTOcean Environmental Module provides functions to assess and compare the environmental impact of arrays designed by DTOcean. The environmental impact is given by two numerical values, one for positive and one for negative impacts. Recommendations on how to reduce negative impacts are also provided.
See dtocean-app or dtocean-core to use this package within the DTOcean ecosystem.
- For python 2.7 only.
Installation and development of dtocean-environment uses the Anaconda Distribution (Python 2.7)
To install:
$ conda install -c dataonlygreater dtocean-environment
Conda can be used to install dependencies into a dedicated environment from the source code root directory:
$ conda create -n _dtocean_eia python=2.7 pip
Activate the environment, then copy the .condrc file to store installation
channels:
$ conda activate _dtocean_eia
$ copy .condarc %CONDA_PREFIX%
Install polite into the environment. For example, if installing it from source:
$ cd \\path\\to\\polite
$ conda install --file requirements-conda-dev.txt
$ pip install -e .
Finally, install dtocean-environment and its dependencies using conda and pip:
$ cd \\path\\to\\dtocean-environment
$ conda install --file requirements-conda-dev.txt
$ pip install -e .
To deactivate the conda environment:
$ conda deactivate
A test suite is provided with the source code that uses pytest.
If not already active, activate the conda environment set up in the Source Code section:
$ conda activate _dtocean_eia
Install packages required for testing to the environment (one time only):
$ conda install -y pytest
Run the tests:
$ py.test tests
To uninstall the conda package:
$ conda remove dtocean-environment
To uninstall the source code and its conda environment:
$ conda remove --name _dtocean_eia --all
Examples of using dtocean-core are given in Jupyter Notebooks which are found in the "notebooks" folder of the dtocean-core source code. The notebooks should be used from the installation conda environment. To install jupyter and the matplotlib plotting library:
$ activate _dtocean_eia
$ conda install -y jupyter matplotlib
Then, to start the jupyter notebook in your default browser:
$ start jupyter notebook
Note, you only need to activate the environment once per session.
It is important that the "test_data" directory is copied into the same directory where the notebooks are being executed from. You can customise this directory using the config file described here and setting the "notebook_dir" variable.
Once the test_data directory has been placed alongside the notebook, the notebook can be executed in the normal way.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
See this blog post for information regarding development of the DTOcean ecosystem.
Please make sure to update tests as appropriate.
This package was initially created as part of the EU DTOcean project by:
- Mathew Topper at TECNALIA
- Rui Duarte at France Energies Marines
- Imanol Touzon at TECNALIA
- Jean-Francois Filipot at France Energies Marines
It is now maintained by Mathew Topper at Data Only Greater.