Skip to content

Commit

Permalink
Merge branch 'port-widget'
Browse files Browse the repository at this point in the history
  • Loading branch information
danbryce committed Oct 25, 2022
2 parents ee06223 + 265e2e0 commit fd36667
Show file tree
Hide file tree
Showing 54 changed files with 6,412 additions and 2,734 deletions.
14 changes: 8 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ __pycache__/
*.so

# Distribution / packaging
.DS_store
.Python
build/
develop-eggs/
Expand Down Expand Up @@ -39,17 +40,18 @@ instance/
.webassets-cache

**/__pycache__/**
pamled/editor/static/**
pamled/editor/templates/**
laboped/editor/static/**
laboped/editor/templates/**
**/.vscode
pamled/.env
laboped/.env
**/node_modules
**/.editorconfig
pamled/general.log
laboped/general.log
general.log
backend/pamled_editor/migrations
backend/laboped_editor/migrations
backend/api/migrations
backend/editor/migrations
backend/accounts/migrations
backend/media/
oso
oso
**/*.gv*
9 changes: 5 additions & 4 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@ djangorestframework = "*"
django-oso = "*"
jsonfield = "*"
python-decouple = "*"
pypaml = {git = "https://github.com/Bioprotocols/paml.git"}

# Keep black at version under 22 because:
# There are incompatible versions in the resolved dependencies:
# - click<8,>=7.0 (from transcriptic==9.5.0)
# - click>=8.0.0 (from black==22.1.0)
black = "<22"
black = "*"
labop = {editable = true, path = "./../labop"}
opentrons = "*"
ipython = "*"

[requires]
python_version = "3.9"
python_version = "3.10"

[pipenv]
allow_prereleases = true
1,413 changes: 0 additions & 1,413 deletions Pipfile.lock

This file was deleted.

21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# **Introduction**

The PAML Editor (PAMLED) is a web application that supports the authoring and sharing of PAML protocols. PAMLED consists of two components: `frontend` and `backend`. The frontend is a React-based server for handling the graphical interface. The backend is a Django REST server that handles persistent storage (protocols, user accounts, and primitives), and access to the pyPAML library.
The LabOp Editor (LabOPEd) is a web application that supports the authoring and sharing of LabOp protocols. LabOPEd consists of two components: `frontend` and `backend`. The frontend is a React-based server for handling the graphical interface. The backend is a Django REST server that handles persistent storage (protocols, user accounts, and primitives), and access to the pyLabOp library.

# **User Guide**

See the user guide at: [User Guide](frontend/web/src/USERGUIDE.md)

# **Running the PAML Editor in Development**
# **Running the LabOp Editor in Development**

## **Pre-requisites**
- Backend <a name="backend-deps"></a>
Expand All @@ -21,14 +21,14 @@ See the user guide at: [User Guide](frontend/web/src/USERGUIDE.md)

1. On your development system install [backend dependencies](#backend-deps)

2. Get PAMLED:
2. Get LabOPEd:
```bash
git clone https://github.com/Bioprotocols/pamled.git
git clone https://github.com/Bioprotocols/laboped.git
```

3. Initialize the pamled pipenv environment:
3. Initialize the laboped pipenv environment:
```bash
cd pamled
cd laboped
pipenv install
pipenv shell
```
Expand Down Expand Up @@ -61,7 +61,7 @@ Performing system checks...
System check identified no issues (0 silenced).
January 24, 2022 - 18:52:36
Django version 3.2.9, using settings 'pamled.settings'
Django version 3.2.9, using settings 'laboped.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.
```
Expand Down Expand Up @@ -94,7 +94,7 @@ If npm does not open a browser automatically then you can connect to the fronten

## **Development using Visual Studio Code**
---
For those familiar with VSCode the backand and frontend instructions have mostly been encapsulated within a VSCode workspace. See the `pamled.code-workspace` in the root of the repo.
For those familiar with VSCode the backand and frontend instructions have mostly been encapsulated within a VSCode workspace. See the `laboped.code-workspace` in the root of the repo.

**Note** that this workspace does still require `pipenv` and `npm` to be installed.

Expand All @@ -121,4 +121,7 @@ These make it easier to launch all of the editor parts at once.
>- Chrome
>### Compound Launchers
>- Django & React & Firefox
>- Django & React & Chrome
>- Django & React & Chrome
# Mac M1 install
- The oso dependency requires manually building oso, per instructions at: https://github.com/osohq/oso/issues/808. The final install step `make python-build` must be executed in the virtual environment (e.g., `pipenv run make python-build`).

0 comments on commit fd36667

Please sign in to comment.