Giter VIP home page Giter VIP logo

notebooks-stsci's Introduction

Notebooks

CircleCI

This repository contains a curated set of Jupyter notebooks related to the work that we do at STScI. These notebooks follow a consistent style guide in terms of layout/structure, coding conventions etc.

These notebooks are also under continuous integration to ensure that astronomers using these notebooks have a high level of confidence that they will work.

Contents

This repository holds the notebooks themselves, but in a harder-to-read unexecuted form. If you want to view the notebooks online, you should view the rendered versions. At present this includes:

Building Locally

Python 3 is required for use of these notebooks.

To quickly create an environment with everything needed to run and convert, please first install Conda or Miniconda to your machine using Conda Installation Instructions.

Once you have Conda installed, complete the following from a command line:

git clone https://github.com/spacetelescope/notebooks
cd notebooks
conda env create -f environment.yml
conda activate notebooks_env
python convert.py

Doing so will clone this repo, create and activate a conda environment with all needed dependencies, and convert the notebooks to html. For all current notebooks, this can take around 30 minutes.

After converting, you can access the converted HTML of the notebooks in each notebook directory. These can be opened in any web browser. You can also open the index.html file in the root of the repo after converting that links to all converted notebooks.

If you would like to view the notebooks in Jupyter, from the command line in the notebooks directory use:

jupyter notebook

Your web browser will open a new page and you can navigate the notebook directories and click the a notebook file (ends in .ipynb) to open.

Contributing

If you want to suggest changes to this content (or new content!), check out the contributing guide.

notebooks-stsci's People

Contributors

eteq avatar nkerman avatar jrka avatar theresadower avatar cpsanchez avatar mustaric avatar arfon avatar kelle avatar catherine-martlin avatar emmalieb avatar samanthalh avatar pllim avatar scfleming avatar barentsen avatar milchada avatar josiebunnell avatar cshanahan1 avatar tddesjardins avatar ojhall94 avatar jcurtin-stsci avatar havok2063 avatar jbcurtin avatar jmao2014 avatar mcara avatar benmontet avatar rlwastro avatar

Watchers

 avatar

notebooks-stsci's Issues

Solution notebook

Reminder to decide how to proceed with the solution notebook, whether to upload two (one only with the exercises and one with the exercises + solutions), directly upload the one with the exercises + solutions, or else.

How to properly reference multi-part tutorials?

A number of us have ended up splitting up our tutorials into multiple parts. What is the best way to reference "the other part" in the tutorials? What information should be reproduced in each one? What I did in #12 and #13 was to make explicit reference to the other tutorial in the Learning Goals and Introduction sections. I think the second part also required you to use some results from the first one.

Are there some Dos and Don'ts for multi-part tutorials?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.