CWorthy-ocean / C-Star

C-Star is a python package for setting up and running ocean model simulations, with a particular focus on marine carbon dioxide removal (mCDR) applications.
https://c-star.readthedocs.io
10 stars 4 forks source link

Conda environments #61

Closed NoraLoose closed 1 month ago

NoraLoose commented 1 month ago

Right now, we provide the user with the following instructions (in the README and documentation):

i. Create a new conda environment containing any dependencies: conda create -n "cstar_environment python=3.12 pooch pyyaml

If you are installing on an M2 (Apple silicon) Mac, you'll also need to add:

compilers=1.6.0 netcdf-fortran=4.6.1 mpich=4.1.2 nco=5.1.8 -c conda-forge

It may also be worth including ipython,xarray,numpy, matplotlib and jupyter in the environment to work with any output, though these are not needed to run C-Star.

It would be good to automate this for the user and provide a few conda environments that the user can install and activate. We probably need multiple environments based on whether the user is on HPC or their laptop.

Action items

NoraLoose commented 1 month ago

I think we can close this as this was done in #83, #90, #91.