Skip to main content

Example climetlab external dataset plugin

Project description

# CliMetLab Web

A web application to manage the cache content and configuration settings of the [CliMetLab](https://github.com/ecmwf/climetlab) Python package.

## Installation

Installation in a virtual environment is advised.

### Using pip

` pip install climetlab-script-web `

### From source

#### Clone Repository

` git clone https://github.com/ecmwf-lab/climetlab-script-web `

#### Install Backend

This installs CliMetLab and related backend packages. Core packages are listed in setup.py while development packages are listed in requirements.txt.

` cd climetlab-script-web pip install -e . pip install -r requirements.txt `

#### Install Frontend

Check out the Github actions file for details.

` cd frontend npm install npm test npm run build mv build ../climetlab_script_web/build `

#### Run

Run the following command from project’s root and navigate to http://127.0.0.1:8080 in your browser.

` climetlab_web `

## Development

### Run Frontend Server

The frontend server runs at http://127.0.0.1:3000.

` cd frontend/ npm start `

### Run Backend Server

The backend server runs at http://127.0.0.1:5000.

` cd climetlab_script_web/ flask run `

### Code Changes

  • Open your browser and navigate to http://127.0.0.1:3000

  • Changes in the frontend will automatically reflect here.

  • Changes in the backend will require a restart of flask server unless you do: export FLASK_ENV=development.

  • Use Makefile commands for improved development experience (make help).

  • A pre-commit hook performs linting, formatting, and testing for both ReactJs and Python code.

### Prepare For Deployment

Create a frontend build output and move the file to backend’s root.

` cd frontend npm run build mv build ../climetlab_script_web/build `

Or you can also simply type make build. (_See Makefile for automation._)

Bump package version in the climetlab_script_web/version file.

Finally, run climetlab_web from the project’s root and navigate to http://127.0.0.1:8080 in your browser.

# Licence

See LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

climetlab-script-web-0.1.8.tar.gz (326.6 kB view details)

Uploaded Source

File details

Details for the file climetlab-script-web-0.1.8.tar.gz.

File metadata

  • Download URL: climetlab-script-web-0.1.8.tar.gz
  • Upload date:
  • Size: 326.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for climetlab-script-web-0.1.8.tar.gz
Algorithm Hash digest
SHA256 3ad1115edab4dba568b867f7dc5e226a2edbf42913703fea3b861533f6af3fa4
MD5 a8531e252f78744870af0e5a1e374e40
BLAKE2b-256 2acc6dab84a13448f5b1e1625253bd74a975e05efc11cf5c9aca7209db77e14b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page