Skip to content

Commit

Permalink
FUSE_examples --> FuseExamples
Browse files Browse the repository at this point in the history
  • Loading branch information
orso82 committed Sep 16, 2024
1 parent 26713f6 commit d219afa
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
12 changes: 6 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -509,18 +509,18 @@ install_ci_dev: install_registry https_dev

# @devs
install_examples_dev:
# Install FUSE_examples under FUSE/examples
@if [ ! -d "examples" ]; then git clone git@github.com:ProjectTorreyPines/FUSE_examples.git examples ; else cd examples && git pull; fi
# Install FuseExamples under FUSE/examples
@if [ ! -d "examples" ]; then git clone git@github.com:ProjectTorreyPines/FuseExamples.git examples ; else cd examples && git pull; fi

# @devs
install_no_registry: install_registry clone_pull_all develop
# Install FUSE without using the registry

# @devs
install_playground: .PHONY
# Clone FUSE_playground repository under FUSE/playground folder
# Clone FusePlayground repository under FUSE/playground folder
if [ -d playground ] && [ ! -f playground/.gitattributes ]; then mv playground playground_private ; fi
if [ ! -d "playground" ]; then git clone git@github.com:ProjectTorreyPines/FUSE_playground.git playground ; else cd playground && git pull origin `git rev-parse --abbrev-ref HEAD` ; fi
if [ ! -d "playground" ]; then git clone git@github.com:ProjectTorreyPines/FusePlayground.git playground ; else cd playground && git pull origin `git rev-parse --abbrev-ref HEAD` ; fi

# @devs
install_via_registry: install_registry develop
Expand Down Expand Up @@ -785,8 +785,8 @@ install_IJulia:

# @user
install_examples:
# Install FUSE_examples in current folder
@cd $(PTP_ORIGINAL_DIR) && if [ ! -d "FUSE_examples" ]; then git clone git@github.com:ProjectTorreyPines/FUSE_examples.git ; else cd FUSE_examples && git pull; fi
# Install FuseExamples in current folder
@cd $(PTP_ORIGINAL_DIR) && if [ ! -d "FuseExamples" ]; then git clone git@github.com:ProjectTorreyPines/FuseExamples.git ; else cd FuseExamples && git pull; fi

# @user
install_registry:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ Let's now investigate where the issue is with the function that we have identifi

## Examples

The [FUSE_examples repository](https://github.com/ProjectTorreyPines/FUSE_examples) contains jupyter notebook that showcase some possible uses of FUSE.
The [FuseExamples repository](https://github.com/ProjectTorreyPines/FuseExamples) contains jupyter notebook that showcase some possible uses of FUSE.

!!! note
When committing changes to in a jupyter notebook, make sure that all the output cells are cleared! This is important to keep the size of the repository in check.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/examples.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Worked examples

[FUSE Jupyter examples](https://github.com/ProjectTorreyPines/FUSE_examples) are available and can be cloned to the current working directory with:
[FUSE Jupyter examples](https://github.com/ProjectTorreyPines/FuseExamples) are available and can be cloned to the current working directory with:

```bash
fusebot install_examples
Expand Down
4 changes: 2 additions & 2 deletions docs/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ For installation start your Julia interpreter by typing `julia` at the terminal,
] test FUSE
```

1. Exit julia and clone [`FUSE examples`](https://github.com/ProjectTorreyPines/FUSE_examples) in the current working directory. To see/run those `.ipynb` files, you'll need to use Jupyter-Lab or VScode.
1. Exit julia and clone [`FUSE examples`](https://github.com/ProjectTorreyPines/FuseExamples) in the current working directory. To see/run those `.ipynb` files, you'll need to use Jupyter-Lab or VScode.

```bash
fusebot install_examples
Expand Down Expand Up @@ -81,4 +81,4 @@ For installation start your Julia interpreter by typing `julia` at the terminal,
jupyter-lab
```

1. Now you can browse the examples in the `FUSE_examples` folder that you have cloned, and take a tour of the example Jupyter notebooks there.
1. Now you can browse the examples in the `FuseExamples` folder that you have cloned, and take a tour of the example Jupyter notebooks there.

0 comments on commit d219afa

Please sign in to comment.