Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aperiosoftware/esac-astropy

Astropy workshop at ESAC - October 23-25
https://github.com/aperiosoftware/esac-astropy

Last synced: 4 days ago
JSON representation

Astropy workshop at ESAC - October 23-25

Awesome Lists containing this project

README 

        
# ESAC Astropy Course - October 23rd-25th 2019



During the workshop you can take notes on questions/issues/requests in [this document](https://docs.google.com/document/d/1OHHypIeLezcy6Qj0NAUynF30tW5plnJdm4eI9fllUxc/edit?usp=sharing

).



You can also give feedback on the workshop using [this form](https://docs.google.com/forms/d/e/1FAIpQLSf6gbG30wb_wJpMKBwonjoJ84REFgRQVWpeR0-NgHlDX40zCw/viewform).



## Contributing to open source software



This workshop makes use of several open source software packages, primarily astropy, which rely on contributions from the community.

If you're interested in contributing to the development or organisation of open source software, see [this list of resources](contributing.md).



## If you are short on time



Before we go over the installation instructions, if you don't have time or are

not able to install the software on your laptop in time for the workshop, you

can use the notebooks online instead by clicking on the following button:



[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/aperiosoftware/esac-astropy/master)



If this works, you can just ignore the rest of this README! (though we recommend

trying to install the software if you can since it will be useful to have on

your laptop and we can help with installation issues).



## Notebooks



To download the notebooks to your laptop, run:



    git clone https://github.com/aperiosoftware/esac-astropy.git



If this does not work for any reason, download and unpack

[this zip file](https://github.com/aperiosoftware/esac-astropy/archive/master.zip)

instead. In both cases, once you have downloaded this, go inside the

``esac-astropy`` folder before proceeding to the next section:



    cd esac-astropy



## Requirements and installation



To run all the notebooks on your laptop, you will need the following software

installed:



* Python 3.5 or later

* Jupyter Notebook

* Numpy

* Matplotlib

* SciPy

* Astropy 3.2 or later

* reproject

* photutils

* regions

* astropy-healpix

* astroquery

* APLpy

* PyVO



If you have never used Python before, we recommend downloading the [Miniconda

distribution](https://docs.conda.io/en/latest/miniconda.html) and installing it

then following the steps for **Option 1: If you use conda** below.



If you normally use Python and think you might already have these, go to

the **Checking your installation** section at the bottom of this file.



### Option 1: If you use conda



If you use conda, the easiest way to get set up quickly is to create a new

environment with all the required dependencies by running:



    conda env create -n astropy-workshop -f environment.yml



Anytime you want to switch to this environment, you can then do:



    conda activate astropy-workshop



(if this doesn't work, try ``source activate astropy-workshop``).



If you want to start using any of the packages in your regular environment after

the workshop, see the **Option 3: Manual conda installation** section.



### Option 2: If you use pip



If you normally use pip to manage your dependencies, provided that you are using

Python 3.5 or later you can install all the required dependencies by running:



    pip install -r requirements.txt



If you prefer to install dependencies individually, see the **Option 4: Manual

pip installation** section.



### Option 3: Manual conda installation



If you want to install the packages into an existing conda environment, make

sure that environment has Python 3.5 or later installed, then run:



    conda install notebook numpy matplotlib scipy "astropy>=3.2"

    conda install -c astropy reproject photutils astropy-healpix regions astroquery aplpy

    pip install PyVO



### Option 4: Manual pip installation



If you want to install the packages into an existing Python environment with

pip, make sure that environment has Python 3.5 or later installed, then run:



    pip install notebook numpy matplotlib scipy "astropy>=3.2"

    pip install reproject photutils astropy-healpix regions astroquery aplpy PyVO



## Checking your installation



Once you have followed one of the installation options above, you can start

up the notebook server by running:



    jupyter notebook



To check that your installation works, open the ``00-check-installation``

notebook, then go to the **Cell** menu and click on **Run All**. If there are no

errors, you are all set to go!