Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cache 3-4 interference and tunneling models in MongoDB #24

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,8 @@
/src/setup/

# misc
.ini
.DS_Store
.env
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
Expand Down
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
Computational Nano Lab, UFL

## Architecture Overview
![image](https://github.com/user-attachments/assets/36da6434-28a5-4bd1-9704-8288bce7b5be)

![image](https://github.com/user-attachments/assets/6abb6ef0-1a6d-466c-b85a-ab1bcdbac57a)

## Getting Started

Expand Down Expand Up @@ -65,17 +64,26 @@ For example, I run the backend and I get "Running on http://127.0.0.1:3001". Tak

2. Utilize 2 terminals in parallel to run the back and the frontend.

3. If you're cloning the project for the first time and changes to `/src/setup` are being tracked, run:
3. Rename the `sample_ini` to `.ini` and replace the variable with the connection string from MongoDB Atlas.
```
git update-index --assume-unchanged src/setup/
mv sample_ini .ini
```

[Get your Atlas cluster](https://docs.atlas.mongodb.com/getting-started/) with [sample data](https://docs.atlas.mongodb.com/sample-data/) set [connection string](https://docs.atlas.mongodb.com/connect-to-cluster/) and place in `DB_URI` parameter under `.ini`

Make sure you have IP in the Atlas [access list](https://docs.atlas.mongodb.com/security/add-ip-address-to-list/) and username/password of your Atlas user correctly specified.

## File Structure
- `/src/` - Contains the source code for the React website.
- `/src/App.tsx` - The main entry point for the website. This is where the React Router is set up to route to the different pages.
- `/src/pages` - Where each sub-page files are located
- `/backend_functions/` - Contains the backend code for handling requests and generating model gifs
- `/backend_functions/model_generators` - Contains the python code used to generate each model, ie `interference.py` or `tunneling.py`
- `/src/data/content.json` - Contains the data for each text block on a page.
- If you are generating a new page you may use the component `<CustomDescriptionBox pageTitle=<name>/>`. This will make a box for each item in the pages content. The message will be rendered in markdown style for a better visual experience.
- It can handle image urls with the `imageUrl` parameter or a file in the public folder with `imagePath`
- For example `"imagePath": "/Single_V4.png"`
- For example `"imageUrl": "https://quantumawareness.net/wp-content/uploads/2019/01/doubleslottest-1400x793-71-2.jpg"`

## Tech Stack
### React
Expand Down
Loading
Loading