This is a web-application that provides a user-interface to the popuar 21cmSense code. 21cmSense is a sensitivity calculator for 21cm radio telescopes observing the first billion years of the Universe.

First clone this repo:

git clone git@github.com:steven-murray/21cmSense-app.git
cd 21cmsense-app

Install Python dependencies (install python with your package manager if necessary):

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Now install yarn with your package manager.

source venv/bin/activate
python run-app.py

Usage:

usage: run-app.py [-h] [--port PORT] [--bind-address BIND_ADDRESS_RAW]

Web interface for py21cmSense astronomy software

optional arguments:
  -h, --help            show this help message and exit
  --port PORT
  --bind-address BIND_ADDRESS_RAW

docker run -d -p8081:80 p43:latest

U+2139 Use of the port publish parameter: [local bind addr:]local_port:container_port[/protocol] So to bind port 80 of the container (where nginx is listening) to port 8081 on the local machine, listening on 0.0.0.0 (all interfaces), use -p 8081:80/tcp.

-d detaches the container after run

To build a docker container for running the application, using nginx as a webserver utilizing the wsgi interface to the python code, please see the README in the docker-dist directory.

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Docker: docker-dist/README.md

API: docs/API.md