EarthCubeInGeo / resen-core

The core docker image used by resen.
GNU General Public License v3.0
2 stars 3 forks source link

[ENH]: Include AMGeO #68

Closed asreimer closed 3 years ago

asreimer commented 3 years ago

This PR adds AMGeO to resen-core.

Using AMGeO

AMGeO is used by running it from the command line. Documentation is available here, after you register for an AMGeO account: https://amgeo.colorado.edu/protected/documentation/index.html.

Note that the setup_amgeo.sh script included in this PR changes the default output directory for AMGeO outputs from ~/amgeo_v2_output to ~/work/amgeo_v2_output.

Configure

To configure AMGeO, navigate to ~/bin/amgeo/AMGeO-2.0.0beta and then run:

python configure.py

after which you will need to enter your AMGeO API token, which you get from the AMGeO website once you have registered: https://amgeo.colorado.edu. Then you enter your SuperMAG and AMPERE usernames, which you get when you register on their websites: https://supermag.jhuapl.edu/ and http://ampere.jhuapl.edu/.

Running AMGeO

To run, we need to run the driver_default.py script in the ~/bin/amgeo/AMGeO-2.0.0beta/AMGeO directory:

python driver_default.py 2015 3 17 N --hour 3 --minute 2 --second 30

and the output from this will be placed inside of ~/work/amgeo_v2_output by default.

Notes

By default, datafiles used by AMGeO are downloaded and saved to ~/.local/share/AMGeO/ and ~/.local/share/nasaomnireader.

Testing this PR

  1. Build the resen-core Dockerfile: docker build -t testing .
  2. Test the resulting docker image by adding it to the available cores that resen can use. This is done by adding a testing.json file to ~/.config/resen/cores.

Recommended format:

[
    {"version":"latest","repo":"testing","org":"earthcubeingeo",
     "image_id":"ADD IMAGE HASH HERE",
     "repodigest":"sha256:b793f427f49aba05e38cb72b74789f2f5fd030b0be8a7639e48d24803b5da0a8",
     "envpath":"/home/jovyan/envs/py38"}
]

You can get the image hash with docker images --no-trunc.

asreimer commented 3 years ago

Note that adding AMGeO has increased the size of resen-core from 3.6 GB to 3.9 GB (300 MB).

asreimer commented 3 years ago

As per offline discussions, we'll revist this later.