monty-mvp

A minimalistic website to explore MontyCarlo live demos.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is a minimalistic website for showcasing MontyCarlo in the 4th European Congress of Medical Physics.

(back to top)

Built With

• MontyCarlo
• Next.js
• Django
• Docker

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Docker

Installation

1. Clone the repository and cd into it;

git clone git@github.com:RuiFilipeCampos/monty-mvp.git
cd monty-mvp

2. Docker compose it

docker-compose up

(back to top)

Roadmap

• /simple_sphere/ - frontend page: performs GET /sphere/ on backend, graphs the result (graph takes a while to load, wait for it)

• /sphere/ - frontend page: performs POST /sphere/ on backend with parameters as payload
• /onion/
• /cut-sphere/

(back to top)

Contributing

To get a copy for local development up and running follow these simple example steps.

Prerequisites

• yarn
• poetry
• docker

Installation

Start by cloning the repository

git clone git@github.com:RuiFilipeCampos/monty-mvp.git
cd monty-mvp

Client Side Code

1. Install client side packages

cd client
yarn

2. Start the development server

yarn dev

This will get the frontend up and running on port localhost:8000 and on port 8000 of your local network.

Server Side Code

1. Perform the first docker build. This will take a while the first time, but is instantaneous afterwards(just make sure not to change the generate_materials.py file).

cd server
docker build . -t monty-mvp:server

2. Start a container with this image, map its 0.0.0.0:8000 to your localhost:8000

docker run -itp 8000:8000 monty-mvp:server

(back to top)

Contact

Rui Campos - mail@ruicampos.org

Project Link: https://github.com/RuiFilipeCampos/monty-mvp

(back to top)