Topography Storage and Calculation Service for Contact Mechanics.
Moved to settings.
The application uses ORCID for user authentication, so you need an ORCID account to use it.
If you need a super user or staff user during development, e.g. for acccessing the admin page, connect to the datbase and set the is_superuser or is_staff flags manually.
$ USE_DOCKER=no DJANGO_SETTINGS_MODULE=config.settings.test pytestOr use run configurations in your IDE, e.g. in PyCharm.
We are testing the code quality in the test pipeline, if your code is not conform with flake8, the pipeline will fail. To prevent you from committing non-conform code, you can install pre-commit. pre-commit runs tests on your code befor the commit. Just install pre-commit with pip or your package manager. Then run:
pre-commit installThats all you really need to do!
To run the pre-commit hooks by hand you can run:
pre-commit runIf you want to skip a pre-commit stage, i.e. flake8, run:
SKIP=flake8 pre-commit runThe full application can be run in Docker containers, for development and production. This also includes the database, message brokers, celery workers and more. It is currently the easiest way to run the full stack.
See the Sphinx documentation how to install docker and how to start the application using docker, for deployment (see chapter "Deploy") or local development (see "Installation on development machine / Starting Topobank in Docker").
This app comes with Celery.
To run a celery worker:
cd topobank
celery -A topobank.taskapp worker -l infoPlease note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.
There is a bash script start-celery.sh which also sets some environment variables needed in order to connect to the message broker and to the result backend.
Development of this project is funded by the European Research Council within Starting Grant 757343.