ANU-inversion-course 0.1.0.dev13

ANU Inversion Course Package

ANU Inversion Course Package

This package contains resources to be used in the inversion course practicals.

Table of contents

• Getting started
  • Pre-requisites
  • Set up a virtual environment (optional)
  • Installation
  • Check
• Troubleshooting
• Developer notes

Getting started

1. Pre-requisites

Before installing the ANU-inversion-course package, make sure you have the following ready:

• A computer
• OS-specific dependencies
  • For Linux users: ensure your apt / dnf / pacman works
  • For MacOS users:
    1. download XCode from "App Store" (you'll need to create an Apple account if not already)
    2. install command line tools by typing this in the "Terminal": xcode-select --install
  • For Windows users: install Cygwin, and remember to use it for the following dependencies
• Python >= 3.6
• gfortran

2. Set up a virtual environment (optional)

It's recommended to use a virtual environment (e.g. venv, virtualenv, mamba or conda) so that it doesn't conflict with your other Python projects.

Open a terminal (or a Cygwin shell for Windows users) and refer to the cheat sheet below for how to create, activate, exit and remove a virtual environment.

venv

Ensure you have python >= 3.6.

Use the first two lines below to create and activate the new virtual environment. The other lines are for your future reference.

$ python -m venv <path-to-new-env>/inversion_course           # to create
$ source <path-to-new-env>/inversion_course/bin/activate      # to activate
$ deactivate                                                  # to exit
$ rm -rf <path-to-new-env>/inversion_course                   # to remove

virtualenv

Use the first two lines below to create and activate the new virtual environment. The other lines are for your future reference.

$ virtualenv <path-to-new-env>/inversion_course -p=3.10       # to create
$ source <path-to-new-env>/inversion_course/bin/activate      # to activate
$ deactivate                                                  # to exit
$ rm -rf <path-to-new-env>/inversion_course                   # to remove

mamba

Use the first two lines below to create and activate the new virtual environment. The other lines are for your future reference.

$ mamba create -n inversion_course python=3.10                # to create
$ mamba activate inversion_course                             # to activate
$ mamba deactivate                                            # to exit
$ mamba env remove -n inversion_course                        # to remove

conda

Use the first two lines below to create and activate the new virtual environment. The other lines are for your future reference.

$ conda create -n inversion_course python=3.10                # to create
$ conda activate inversion_course                             # to activate
$ conda deactivate                                            # to exit
$ conda env remove -n inversion_course                        # to remove

3. Installation

Type the following in your terminal (or Cygwin shell for Windows users):

$ pip install jupyterlab anu-inversion-course

4. Check

And when you run jupyter-lab to do the practicals, make sure you are in the same environment as where your anu-inversion-course was installed. You can try to test this by checking if the following commands give you similar result:

$ which pip
<some-path>/bin/pip
$ which jupyter-lab
<same-path>/bin/jupyter-lab
$ pip list | grep ANU-inversion-course
ANU-inversion-course               0.1.0

Troubleshooting

If you find problems importing anu_inversion_course.rf, try to search the error message you get. Here contains a nice explanation for the possible cause. And here is how to locate libgfortran:

gfortran --print-file-name libgfortran.5.dylib

Developer Notes

Check out NOTES.md if you'd like to contribute to this package.

1. Getting started
2. Cheatsheet
   1. conda environment
   2. git operations
   3. package development
   4. package metadata
   5. package building test & release
3. Adding C/C++ extensions
4. Adding Fortran extensions
5. More references
6. Appendix - semantic versioning
7. Additional Notes about gfortran