Add docs for using images outside Fornax #39
Conversation
unfortunately, that looks to be the case. |
| cd work | ||
| ``` | ||
| - Clone the notebook repo: `git clone https://github.com/nasa-fornax/fornax-demo-notebooks.git`. | ||
| - Download the relevant Fornax image. In this case, we are using the `tractor-stable` image. `docker pull public.ecr.aws/f6e2z3b0/fornax-images:tractor-stable`. |
There was a problem hiding this comment.
Is the name of this image 'tractor-stable' going to always be the same name in perpetuity, or will the names change? If the names will change, or if we want users to be able to see multiple different environments, then can you teach us users how to figure out the full list of available images? as well as corresponding addresses for those images (ie., is the 'f6e2...' the same for all images?
| @@ -227,6 +227,36 @@ Software is installed in miniconda environments. You can use "[conda list](http | |||
| ### How can I contribute to existing Open-Source Fornax notebook tutorials? | |||
| * open issue or PR on Fornax Github [repo](https://github.com/nasa-fornax/fornax-demo-notebooks) | |||
|
|
|||
| ## Using Fornax Software Environments Outside Fornax | |||
| The Fornax software environments are available as docker container images. To use them on your computer, you will need to install | |||
| [docker](https://docs.docker.com/engine/install/). The following are the steps needed to run the notebooks locally using the Fornax images: | |||
There was a problem hiding this comment.
I did this years ago and it was a somewhat involved process. If this is still the case, maybe a warning is in order for users so that they know this is not some simple 'pip install Docker'. Maybe something like " You can expect this will take ~N - N minutes and N Mb of space on your personal computer"
| @@ -227,6 +227,36 @@ Software is installed in miniconda environments. You can use "[conda list](http | |||
| ### How can I contribute to existing Open-Source Fornax notebook tutorials? | |||
| * open issue or PR on Fornax Github [repo](https://github.com/nasa-fornax/fornax-demo-notebooks) | |||
|
|
|||
| ## Using Fornax Software Environments Outside Fornax | |||
| The Fornax software environments are available as docker container images. To use them on your computer, you will need to install | |||
There was a problem hiding this comment.
Should we add an example motivation?
"If you want to run the Fornax software Environment outside of the Fornax Science Console, that is an available option. Possible use cases for this are if you want to use different CPU/GPU/RAM/storage options than are available to you for free on the Fornax system. Possibly you have your own compute or your own cloud based account" The advantage of using our Software environment is that it is maintained already for you with widely used Astronomy software.
Using the compute images outside Fornax is a use case that came up recently. This PR gives an example of how to use the images on personal computers using docker.