Skip to content

Commit

Permalink
* copy development to master working tree
Browse files Browse the repository at this point in the history
  • Loading branch information
tristan-salles committed Aug 24, 2024
1 parent 52896f5 commit 4c73b85
Show file tree
Hide file tree
Showing 25 changed files with 3,208 additions and 402 deletions.
1 change: 0 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,6 @@ def __getattr__(cls, name):
"pandas",
"scipy",
"petsc4py",
"meshplex",
"scipy.interpolate",
"vtk",
"vtk.util",
Expand Down
3 changes: 1 addition & 2 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,7 @@ to ensure compatibility of all dependencies::
conda config --env --set channel_priority strict
conda install numpy pip scipy numpy-indexed cython compilers
conda install pandas h5py meshio ruamel.yaml
conda install vtk mpi4py petsc4py meshplex
conda install xarray pyproj gflex
conda install vtk mpi4py petsc4py gflex

.. note::

Expand Down
21 changes: 11 additions & 10 deletions docs/getting_started/installDocker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ The goSPL image contains all the dependencies and configuration files required t

Different flavors could be pulled using a tag and recommended ones are:

1. The ``gosplcontainer`` tag points to the github ``v2023`` branch.
2. The ``gosplmaster`` tag points to the github master branch and uses the latest
1. The ``gospl:2024.09.01`` tag points to the ``2024.09.01`` goSPL branch,
2. The ``gosplcontainer`` tag points to the github ``v2023`` goSPL branch,
3. The ``gosplmaster`` tag points to the github master branch and uses the latest
release.

.. note::
Expand All @@ -43,7 +44,7 @@ On top of the libraries required for goSPL, the following main ones are availabl
- xarray, rioxarray, xarray-spatial
- pygmt, cartopy, pygplates
- xesmf, metpy
- stripy, meshio, meshplex, triangle
- stripy, triangle
- vtk, hdf5, netCDF4


Expand All @@ -54,9 +55,9 @@ Pulling the image
^^^^^^^^^^^^^^^^^

Once you have installed Docker on your system, you can ``pull`` the
`goSPL official image <https://hub.docker.com/r/geodels/gospl>`_ as follow::
`goSPL official image <https://hub.docker.com/u/geodels>`_ as follow::

docker pull geodels/gosplmaster
docker pull geodels/gospl:2024.09.01


You can list all the images available on your system as follow::
Expand All @@ -66,7 +67,7 @@ You can list all the images available on your system as follow::

An image can be deleted as follow::

docker rmi geodels/gosplmaster
docker rmi geodels/gospl:2024.09.01


Starting the container from a terminal
Expand All @@ -75,11 +76,11 @@ Starting the container from a terminal
You can then start a docker container (an instance of
an image)::

docker run -it -p 8888:8888 -d -v localDIR:/notebooks/geodels/gosplmaster:latest
docker run -it -p 8888:8888 -d -v localDIR:/notebooks

where ``localDIR`` is the directory that contains the Jupyter Notebooks for your simulation.

Once Docker is running, you could open the Jupyter notebooks on a web browser at the following address: `http://localhost:8888 <http://localhost:8888>`_. This should open in your ``localDIR`` directory.
Once Docker is running, you could open the Jupyter notebooks on a web browser at the following address: `http://localhost:8888 <http://localhost:8888>`_. Going into the `/notebooks` folder you will access your ``localDIR`` directory.

You can list the containers currently existing on your machine by running::

Expand All @@ -92,12 +93,12 @@ running containers.

Docker containers can be stop (so that they do not use CPU or RAM resource)::

docker stop geodels/gosplmaster:latest
docker stop geodels/gospl:2024.09.01


They can also be deleted::

docker rm geodels/gosplmaster:latest
docker rm geodels/gospl:2024.09.01


.. important::
Expand Down
18 changes: 0 additions & 18 deletions docs/getting_started/installSrc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,30 +98,12 @@ h5py 2.10.0 Interface to the HDF5 binary data f
pandas 1.1.2 Data analysis and manipulation tool
ruamel.yaml 0.16.12 Parsing YAML to Python objects
meshio 4.2.2 I/O for mesh files.
meshplex 0.13.4 Fast tools for simplex meshes
pre-commit 2.7.1 Managing and maintaining multi-language pre-commit hooks
vtk 9.0.3 Toolkit for 3D computer graphics and image processing
numpy-indexed 0.3.5 Functionality for indexed operations on numpy ndarrays
xarray 0.15.0 Labelled multi-dimensional arrays
pyproj 2.5.0 Interface to PROJ (coordinate transformations)
gflex 1.1.0 Methods to solve elastic plate flexure
========================= ================== =============================================================


Meshplex work-around
----------------------


In case where you are asked to download a licensed version of Meshplex, you might want to try the following alternatives:

1. Use the version available from conda (conda install meshplex) this is version ``v0.15.14`` which is open-source and should work well.
2. Download an older repository of Meshplex such as the one from `Geodels <https://github.com/Geodels/meshplex>`_ ``v0.8.0`` or from `here <https://github.com/kinnala/meshplex>`_ ``v0.13.3`` or `here <https://github.com/cottrell/meshplex>`_ ``v0.17.0``

If you use option 2 and once the folder is downloaded, you can install the code by running in a terminal::

python3 -m pip install .


goSPL installation
----------------------

Expand Down
5 changes: 1 addition & 4 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,16 @@ dependencies:
- build
- numpy
- petsc4py
- pip
- scipy
- numpy-indexed
- pandas
- h5py
- meshio
- vtk
- pre-commit
- ruamel.yaml
- gflex
- mpi4py
- cython
- compilers
- meshplex
- gflex
- pip:
- git+https://github.com/Geodels/gospl.git
Loading

0 comments on commit 4c73b85

Please sign in to comment.