Skip to content

Commit

Permalink
conda environment
Browse files Browse the repository at this point in the history
  • Loading branch information
tristan-salles committed Jun 20, 2024
1 parent 39f90a8 commit c5e48e7
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

## Statement of need

> Since the ’90s, many software have been designed to estimate long-term catchment dynamic, drainage evolution as well as sedimentary basins formation in response to various mechanisms such as tectonic or climatic forcing. These models rely on a set of mathematical and physical expressions that simulates sediment erosion, transport and deposition and can reproduce the first order complexity of Earth’s surface geomorphological evolution.
> Since the ’90s, much software has been designed to estimate long-term catchment dynamics, drainage evolution as well as sedimentary basin formation in response to various mechanisms such as tectonic or climatic forcing. These models rely on a set of mathematical and physical expressions that simulates sediment erosion, transport and deposition and can reproduce the first order complexity of Earth’s surface geomorphological evolution.
> Yet, we were still missing a tool to evaluate global scale evolution of Earth surface and its interaction with the atmosphere, the hydrosphere, the tectonic and mantle dynamics. gospl is the first model designed to address this gap. It can be used to better characterise many aspects of the Earth system ranging from the role of atmospheric circulation on physical denudation, from the influence of erosion and deposition of sediments on mantle convection, from the location and abundance of natural resources to the evolution of life.
Expand All @@ -35,7 +35,7 @@ All contributions should go through our GitHub repository. Bug reports, ideas or

If you decide to contribute to the codebase, ensure that you are using an up-to-date master branch. The latest development version will always be there, including the documentation (powered by sphinx).

Details are available in the documentation.
Details are available in the [documentation](https://gospl.readthedocs.io).

## License

Expand Down
6 changes: 6 additions & 0 deletions docs/getting_started/installConda.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,12 @@ Navigate to the directory containing the `conda-env.yml <https://raw.githubuserc

This will create an environment with the dependencies and packages required to run :mod:`gospl`.

.. note::

There is no Anaconda ``petsc4py`` win64 package. A ``WSL`` conda install will work once you have make installed.

To put yourself inside this environment

To put your self inside this environment run::

source activate gospl-package
Expand Down
30 changes: 30 additions & 0 deletions environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: gospl
channels:
- conda-forge
- defaults
dependencies:
- python=3.11
- meson-python>=0.15.0
- setuptools>=61.0
- pkg-config
- build
- numpy
- petsc4py
- pip
- scipy
- numpy-indexed
- pandas
- h5py
- meshio
- vtk
- pre-commit
- ruamel.yaml
- mpi4py
- cython
- compilers
- meshplex
- xarray
- pyproj
- gflex
- pip:
- git+https://github.com/Geodels/gospl.git

0 comments on commit c5e48e7

Please sign in to comment.