Skip to content

Commit 641e97f

Browse files
committed
update doc
1 parent 34fe245 commit 641e97f

File tree

3 files changed

+24
-34
lines changed

3 files changed

+24
-34
lines changed

Makefile

-32
Original file line numberDiff line numberDiff line change
@@ -132,38 +132,6 @@ list-tests:
132132
tests:
133133
$(PYTHON) -m pytest -rA --html=$(TEST_RESULTS) --self-contained-html tests/
134134

135-
docker:
136-
mkdir docker-build
137-
rsync -a --exclude=__pycache__ --exclude=docker-build . docker-build
138-
cd docker-build && docker build -t dockerized-pynucleus .
139-
# rm -rf docker-build
140-
141-
docker-linux:
142-
podman run -it \
143-
-v $(XAUTHORITY):/root/.Xauthority \
144-
-v "/tmp/.X11-unix:/tmp/.X11-unix:rw" \
145-
-e DISPLAY=$(DISPLAY) \
146-
--network "host" \
147-
-e HTTP_PROXY=$(HTTP_PROXY) \
148-
-e HTTPS_PROXY=$(HTTPS_PROXY) \
149-
-e http_proxy=$(http_proxy) \
150-
-e https_proxy=$(https_proxy) \
151-
-v $(PWD):/home/pynucleus \
152-
-w "/home/pynucleus/" \
153-
localhost/pynucleus-test
154-
155-
docker-mac:
156-
docker run -it \
157-
-v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=unix$(DISPLAY) \
158-
--network host \
159-
-e HTTP_PROXY=$(HTTP_PROXY) \
160-
-e HTTPS_PROXY=$(HTTPS_PROXY) \
161-
-e http_proxy=$(http_proxy) \
162-
-e https_proxy=$(https_proxy) \
163-
-v $PWD:/home/pynucleus \
164-
-w "/home/pynucleus/" \
165-
dockerized-pynucleus
166-
167135
prereq:
168136
$(PYTHON) -m pip install $(PIP_FLAGS) $(PIP_INSTALL_FLAGS) wheel Cython cython numpy scipy matplotlib pyyaml h5py pybind11 MeshPy tabulate modepy mpi4py pyamg meshio
169137
$(PYTHON) -m pip install $(PIP_FLAGS) $(PIP_INSTALL_FLAGS) scikit-sparse

README.rst

+11-1
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,22 @@ Possible ways to install and use PyNucleus
7575

7676
There are several ways to install and run PyNucleus:
7777

78+
* JupyterHub cloud instance
7879
* container image
7980
* Spack installation
8081
* manual installation
8182

82-
The easiest way to get up and running is probably the container image.
83+
The easiest way to get up and running is probably to run it in the cloud. For a local installation we recommend the container image.
8384

85+
Running in the cloud
86+
--------------------
87+
88+
PyNucleus can be run directly for free from the browser on a JupyterHub server hosted at `mybinder.org <https://mybinder.org/>`_.
89+
90+
.. |binder| image:: https://mybinder.org/badge_logo.svg
91+
:target: https://mybinder.org/v2/gh/sandialabs/PyNucleus/binder
92+
93+
Just click here to launch a notebook server: |binder|
8494

8595
Container image
8696
----------------

docs/installation.rst

+13-1
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,23 @@ Installation
44

55
There are several ways to install and run PyNucleus:
66

7+
* JupyterHub cloud instance
78
* container image
89
* Spack installation
910
* manual installation
1011

11-
The easiest way to get up and running is probably the container image.
12+
The easiest way to get up and running is probably to run it in the cloud. For a local installation we recommend the container image.
13+
14+
Running in the cloud
15+
--------------------
16+
17+
PyNucleus can be run directly for free from the browser on a JupyterHub server hosted at `mybinder.org <https://mybinder.org/>`_.
18+
19+
.. |binder| image:: https://mybinder.org/badge_logo.svg
20+
:target: https://mybinder.org/v2/gh/sandialabs/PyNucleus/binder
21+
22+
Just click here to launch a notebook server: |binder|
23+
1224

1325
Pre-built container image
1426
-------------------------

0 commit comments

Comments
 (0)