CANVAS - 3D editor for the AI-enhanced differentiable Ray Tracer ARTIST

Installation

We heavily recommend to install CANVAS package in a dedicated Python3.10+ virtual environment (click here for the documentation).

After setting up and activating the virtual environment (or deciding against it), execute the following instructions, to set up the code base

# You may have to replace python with python3, depending on your operating system.
# clone the repo
git clone https://github.com/ARTIST-Association/CANVAS.git

# install requirements
cd CANVAS-PSE2425/
pip install -r requirements.txt

# Installing Pre-commit Hooks
pre-commit install

# add the .env file to the root of the canvas_editor folder
# containing debug variable, client_id + secret_key for OpenID, email-host password, etc.

# configure the database
cd canvas_editor/
python manage.py migrate

# Install npm dependencies
npm install

# start the server
python manage.py runserver

# access the website under the in the command line specified url

How to contribute

Check out our contribution guidelines if you are interested in contributing to the CANVAS project 🔥. Please also carefully check our code of conduct 💙.

License

Liberally licensed under MIT.

Acknowledgments

This work is supported by the Helmholtz AI platform grant.

---