Skip to content

Commit

Permalink
Move large mesh files into lfs storage (#196)
Browse files Browse the repository at this point in the history
* Automatically store all mesh files in git lfs.

* Move mesh files into git lfs.

* Document the usage of git lfs/
  • Loading branch information
ludgerpaehler authored Oct 24, 2024
1 parent 5b691fd commit 8698bf0
Show file tree
Hide file tree
Showing 11 changed files with 45 additions and 1,708,190 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.msh filter=lfs diff=lfs merge=lfs -text
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,23 @@ need to _separately_ ensure the solver backend is installed (again, currently al
Alternatively (and this is important for large-scale RL training), the core Hydrogym package can (or will soon be able to) launch reinforcement learning training on a Ray-cluster without an underlying Firedrake install.
For more information and suggested approaches see the [Installation Docs](https://hydrogym.readthedocs.io/en/latest/installation.html).

To add HydroGym to an existing Firedrake installation, and install from the repository, run:

```bash
git clone https://github.com/dynamicslab/hydrogym.git
cd hydrogym
pip install .
```

As the mesh files are stored in [git large file storage](https://git-lfs.github.com/), you will need to install git-lfs
to download the mesh files.

```bash
git lfs install && git lfs fetch --all
```

At which point you are ready to run HydroGym locally.

# Quickstart Guide

Having installed Hydrogym into our virtual environment experimenting with Hydrogym is as easy as starting the Python interpreter
Expand Down
Loading

0 comments on commit 8698bf0

Please sign in to comment.