/hubbleds

Hubble's law data story

Primary LanguagePythonMIT LicenseMIT

Project generated with PyScaffold

Hubble's Law

A Cosmic Data Story about Hubble's Law

Requirements

  • Python-based Cosmic Data Stories now run on solara.
  • hubbleds requires the base cosmicds to be installed.
  • Developers need an API key to access the CosmicDS database. Contact the team for more information.

Installation

  • Optional but recommended, set up a new python environment.
  • Install pip if you don't already have it.
  • If you haven't already installed these packages,
    $ pip install solara
    $ pip install python-dotenv
  • Pull down both the cosmicds & hubbleds repos.
  • Inside the cosmicds folder in your terminal, $ pip install -e .
  • Inside the hubbleds folder in your terminal, $ pip install -e .

Running HubbleDS

Inside the hubbleds folder in your terminal,

    $ CDS_API_KEY="<your api key>" solara run hubbleds.pages --theme-variant dark

Development Tip

If you update .css, you have to force refresh your browser (shift-command-r on a mac) for the changes to register.

Legacy Code

As of 4/30/2024, the voila-based code has been moved to the legacy branch.

To run the legacy code, you also need the legacy branch of the cosmicds repo.

  • Pull down both those branches and set up a new python environment.
  • In the cosmicds directory: $ pip install -e .
  • In the hubbleds directory: $ pip install -e .
  • You may need to pip install any missing dependencies.
  • If you have trouble installing voila, you may need to downgrade your version of node.js to a Long Term Support (LTS) version (14.x or 16.x).
  • Open jupyter notebook and run src/hubbleds/HubbleDS.ipynb

or

  • From the command line: $ cosmicds hubble

Note

This project has been set up using PyScaffold 4.5. For details and usage information on PyScaffold see https://pyscaffold.org/.