Skip to content

Docs: Update installing documentation #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 19, 2022
Merged

Docs: Update installing documentation #253

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a651c5
Docs: Add M1 chip note; more JLab notes [skip ci]
dominiquesydow Jul 19, 2022
3e6b996
Docs: Rephrase JLab instructions [skip ci]
dominiquesydow Jul 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/installing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,18 @@ Install from the conda package
# Windows
mamba create -n teachopencadd teachopencadd -c conda-forge -c defaults

# When using a MacBook Air 12.4 with an M1 chip (2020)
CONDA_SUBDIR=osx-64 mamba create -n teachopencadd teachopencadd

2. Activate the new environment::

conda activate teachopencadd

3. Run ``teachopencadd -h`` to test that it works.
4. Run ``teachopencadd start .`` to set up a new workspace.
4. Run ``teachopencadd start .`` to set up a new workspace with the TeachOpenCADD material. Follow the instructions printed in your terminal to open the material (Jupyter notebooks) with Jupyter Lab.
In this example command, you are setting up your workspace in the current directory ``.``; you can use any other path.

You can always return to your TeachOpenCADD material with ``jupyter lab /path/to/your/teachopencadd/workspace``.


Install from the latest development snapshot
Expand Down