Skip to content

Commit

Permalink
Merge pull request #10 from m2lines/expand-Readme
Browse files Browse the repository at this point in the history
Some small additions to the readme
  • Loading branch information
IamShubhamGupto authored Dec 15, 2023
2 parents 7f40a5c + 85317c6 commit 44998ab
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ git clone [email protected]:m2lines/data-gallery.git
cd data-gallery
conda env create -f environment.yml
```
You can activate the environment with
```
conda activate DGM2lines
```

### To update the existing environment
> :warning: Manually add any new packages to the `environment.yml` either as pip or conda dependencies. Using the default conda environment export causes sub-dependencies to be listed which slows down the `conda-lock` generation process.
Expand All @@ -26,6 +30,8 @@ When you run this command, the notebooks will be executed. The built html will b
cd _build/html
python -m http.server
```
You can then navigate to `http://localhost:8000` in your webbrowser to see the webpage.

The build process can take a long time, so we have configured the setup to use [jupyter-cache](https://jupyter-cache.readthedocs.io/en/latest/). If you re-run the build command, it will only re-execute notebooks that have been changed. The cache files live in `_build/.jupyter_cache`.

To check the status of the cache, run
Expand Down Expand Up @@ -91,8 +97,8 @@ To check your remotes, run

```bash
$ git remote -v
origin [email protected]:rabernat/data-gallery.git (fetch)
origin [email protected]:rabernat/data-gallery.git (push)
origin [email protected]:<your-username>/data-gallery.git (fetch)
origin [email protected]:<your-username>/data-gallery.git (push)
upstream [email protected]:m2lines/data-gallery.git (fetch)
upstream [email protected]:m2lines/data-gallery.git (push)
```
Expand Down

0 comments on commit 44998ab

Please sign in to comment.