Skip to content

joargr/fmu-settings-gui

 
 

Repository files navigation

fmu-settings-gui

ci

fmu-settings-gui is the web frontend for fmu-settings. There are two parts to this repo:

  • The code for the React application, located in the frontend directory. This is the main application, containing the web frontend
  • The code for the Python application, located in the root and in the src directory. This serves the built and deployed React application

Python application

Doing a local pip install will attempt to build the React application behind the scenes. This requires a few dependencies (Node, pnpm, ..) that are not installable via pip. View the frontend README for instructions.

Be sure to include a verbose flag or two (pip install . -vv) if you need to observe the frontend installation output.

Developing

Clone and install into a virtual environment.

git clone [email protected]:equinor/fmu-settings-gui.git
cd fmu-settings-gui
# Create or source virtual/Komodo env
pip install -U pip
pip install -e ".[dev]"
# Make a feature branch for your changes
git checkout -b some-feature-branch

Run the tests with

pytest -n auto tests

Ensure your changes will pass the various linters before making a pull request. It is expected that all code will be typed and validated with mypy.

ruff check
ruff format --check
mypy src tests

See the contributing document for more.

React application

See the application's README file for information.

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 93.8%
  • Python 3.9%
  • JavaScript 1.8%
  • HTML 0.5%