diff options
| author | STAINER Thomas, NEA/SCI/DB <thomas.stainer@oecd-nea.org> | 2025-09-16 10:56:03 +0200 |
|---|---|---|
| committer | SPRENGER Julia, NEA/SCI/DB <julia.sprenger@oecd-nea.org> | 2025-09-16 08:56:03 +0000 |
| commit | 081fc4003c8dab1a3e242026b2f647a7ceec8f5d (patch) | |
| tree | 41ee8579be4f4cca151bf37300833897fcc09275 /README.md | |
| parent | eee582f8594d3b7d01b65660ca1e8bef00eb6b2a (diff) | |
Adding a note on cloning the repository and LFS in the README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 22 insertions, 1 deletions
@@ -22,6 +22,27 @@ In order to compile and run Dragon you must have a Fortran compiler (2003 or lat Optional dependencies are [OpenMP](https://www.openmp.org/resources/openmp-compilers-tools/) and [HDF5](https://www.hdfgroup.org/download-hdf5/). +## Cloning + +To clone this repository from the command line you will need `git` installed. To obtain the code run: + +```bash +git clone https://git.oecd-nea.org/dragon/5.1 +``` + +Note that cloning via https is the simplest as it requires no authentication, if you have an NEA account and you've added your ssh keys to your account you can also clone via ssh: + +```bash +git clone git@git.oecd-nea.org:dragon/5.1.git +``` + +### LFS + +This repository includes some data files used for testing, some of which are quite substantial in size (some up to 100 MB). As a result, Git LFS (Large File Storage), is used to store any files larger than 10 MB. For most cases, users will not need these files unless they wish to run tests locally. + +If you wish to obtain these large files, you require Git LFS installed on your machine (see [here](https://git-lfs.com/) for more details on this). + + ## Installation Dragon is supported on Linux and Unix machines. For Windows users we recommend using the Windows Subsystem for Linux (WSL). @@ -128,4 +149,4 @@ will give me the following outputs ```bash $ls /home/user/dragon/outputs VanDerGucht.result -```
\ No newline at end of file +``` |