-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from m2lines/expand-Readme
Some small additions to the readme
- Loading branch information
Showing
1 changed file
with
8 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
@@ -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 | ||
|
@@ -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) | ||
``` | ||
|