zen-temple 0.3.2__tar.gz → 0.4.0.dev1__tar.gz

{zen_temple-0.3.2/src/zen_temple.egg-info → zen_temple-0.4.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: zen_temple
-Version: 0.3.2
+Version: 0.4.0.dev1
 Summary: The visualization plattform for ZEN Garden
 Author-email: Vinzenz Muser <muserv@ethz.ch>
 Project-URL: Homepage, https://github.com/ZEN-universe/ZEN-temple
@@ -19,8 +19,34 @@ Requires-Dist: zen-garden
 Requires-Dist: mypy>=1.14.1
 
 # ZEN Temple
+ZEN Temple is a FastAPI Application.
 
-ZEN Temple is a FastAPI Application. After installing it with `pip install -e .`, you can start the application with  `uvicorn src.zen_temple.main:app --reload`.
+## Installation
+
+Create a new conda environment, activate it, and install all dependencies:
+
+```bash
+conda create --name <your-env-name> python==3.12
+conda activate <your-env-name>
+pip install -e .
+```
+
+Then, create a new copy of `.env`.
+
+```bash
+cp .env.example .env
+```
+
+Modify the `SOLUTION_FOLDER` variable to the location of your solutions. This is the `outputs` folder generated by ZEN garden. Look at the page [Running a model](https://zen-garden.readthedocs.io/en/latest/files/user_guide/running_models.html#run-zen-garden-with-preexisting-datasets) of the ZEN garden documentation.
+
+## Usage
+
+Activate your conda environment and run the application with this command:
+
+```bash
+conda activate <your-env-name>
+uvicorn src.zen_temple.main:app --reload
+```
 
 ## Folder structure
 

{zen_temple-0.3.2 → zen_temple-0.4.0.dev1}/README.md

@@ -1,6 +1,32 @@
 # ZEN Temple
+ZEN Temple is a FastAPI Application.
 
-ZEN Temple is a FastAPI Application. After installing it with `pip install -e .`, you can start the application with  `uvicorn src.zen_temple.main:app --reload`.
+## Installation
+
+Create a new conda environment, activate it, and install all dependencies:
+
+```bash
+conda create --name <your-env-name> python==3.12
+conda activate <your-env-name>
+pip install -e .
+```
+
+Then, create a new copy of `.env`.
+
+```bash
+cp .env.example .env
+```
+
+Modify the `SOLUTION_FOLDER` variable to the location of your solutions. This is the `outputs` folder generated by ZEN garden. Look at the page [Running a model](https://zen-garden.readthedocs.io/en/latest/files/user_guide/running_models.html#run-zen-garden-with-preexisting-datasets) of the ZEN garden documentation.
+
+## Usage
+
+Activate your conda environment and run the application with this command:
+
+```bash
+conda activate <your-env-name>
+uvicorn src.zen_temple.main:app --reload
+```
 
 ## Folder structure
 

{zen_temple-0.3.2 → zen_temple-0.4.0.dev1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "zen_temple"
-version = "0.3.2"
+version = "v0.4.0.dev1"
 authors = [
   { name="Vinzenz Muser", email="muserv@ethz.ch" },
 ]

zen_temple-0.4.0.dev1/src/zen_temple/explorer/_app/env.js

@@ -0,0 +1 @@
+export const env={}