Localhost documentation

Instructions for running this version of ISOFIT on a local machine

To test the build you can run the following steps:

1. docker run --rm -it serbinsh/isofit_smce:multiarch_v3.4.2 bash This will confirm you can enter the image at the Bash command line. At this stage you should only see the ISOFIT code directory in home

You will also see the stub for where we will map in the external ISOFT examples and data within the container, located at /isofit_data

2. You can confirm the isofit library is functionl and check the version by running
   docker run --rm -it serbinsh/isofit_smce:multiarch_v3.4.2 isofit --version

3. Next you can initialize or check the status of the external ISOFIT data and examples by running

docker run --rm -it -v ~/Data/isofit_home:/home/mambauser/.isofit \
-v ~/Data/isofit_data_docker:/isofit_data serbinsh/isofit_smce:multiarch_v3.4.2 \
isofit -b /isofit_data download all

In this example, we are using the local host directories:

~/Data/isofit_home
~/Data/isofit_data_docker

to map into the empty stub directories within the container

~/Data/isofit_home - to contain the ISOFIT ini configuration file that tells ISOFIT where to find the data ~/Data/isofit_data_docker - contains the data

4. You can then build or check the build of the ISOFIT data and tutorials

docker run --rm -it -v ~/Data/isofit_home:/home/mambauser/.isofit \
-v ~/Data/isofit_data_docker:/isofit_data serbinsh/isofit_smce:multiarch_v3.4.2 \
isofit build

5. Now that you have downloaded the data and built the examples, you can run one of the example scripts, e.g.

docker run --rm -it --shm-size=16gb -v ~/Data/isofit_home:/home/mambauser/.isofit \
-v ~/Data/isofit_data_docker:/isofit_data serbinsh/isofit_smce:multiarch_v3.4.2 \
bash /isofit_data/examples/20151026_SantaMonica/run.sh

6. The new ISOFIT image and data are now ready to run more examples or run new processing workflows!

You can also explore additional examples and customizations using the ISOFIT documentation https://isofit.readthedocs.io/en/latest/custom/docker.html#getting-started

e.g. To use the provided JupyterHub deployment, you can follow the provided instructions by including your newly created directories on your local host,

docker run --rm --shm-size=16gb -p 8888:8888 -v ~/Data/isofit_home:/home/mambauser/.isofit \
-v ~/Data/isofit_data_docker:/isofit_data serbinsh/isofit_smce:multiarch_v3.4.2

After this runs, you can enter into the running container using your browser and navigating to https://127.0.0.1:8888

NOTE: Improved documentation to come