You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+11-10
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
CAiMIRA is a risk assessment tool developed to model the concentration of viruses in enclosed spaces, in order to inform space-management decisions.
4
4
5
-
CAiMIRA models the concentration profile of potential virions in enclosed spaces , both as background (room) concentration and during close-proximity interations, with clear and intuitive graphs.
5
+
CAiMIRA models the concentration profile of potential virions in enclosed spaces , both as background (room) concentration and during close-proximity interactions, with clear and intuitive graphs.
6
6
The user can set a number of parameters, including room volume, exposure time, activity type, mask-wearing and ventilation.
7
7
The report generated indicates how to avoid exceeding critical concentrations and chains of airborne transmission in spaces such as individual offices, meeting rooms and labs.
8
8
@@ -94,8 +94,8 @@ This will start a local version of CAiMIRA, which can be visited at http://local
94
94
95
95
The project contains two different Python packages:
96
96
97
-
-`caimira`: Contains all the backend logic and is the package published in PyPI.
98
-
-`cern_caimira`: Imports the backend package (`caimira`) and includes CERN-specific UI implementation.
97
+
-`caimira`: Contains all the backend logic and the calculator model. It is the package published in PyPI.
98
+
-`cern_caimira`: Imports and uses the backend package (`caimira`) and includes CERN-specific UI implementation.
99
99
100
100
The folder layout follows best practices as described [here](https://ianhopkinson.org.uk/2022/02/understanding-setup-py-setup-cfg-and-pyproject-toml-in-python/).
101
101
@@ -106,14 +106,14 @@ CAiMIRA is also mirrored to Github if you wish to collaborate on development and
106
106
107
107
### Installing CAiMIRA in editable mode
108
108
109
-
In order to install the CAiMIRA's backend logic, from the root directory of the project:
109
+
In order to install the CAiMIRA's backend logic, create your own virtualenv and, from the root directory of the project, run:
110
110
111
111
```
112
112
cd caimira
113
113
pip install -e .
114
114
```
115
115
116
-
In order to install the CERN-specific UI version, that links to the previously installed backend, from the root directory of the project:
116
+
In order to install the CERN-specific UI version, that links to the previously installed backend, activate your virtualenv and, from the root directory of the project, run:
117
117
118
118
```
119
119
cd cern_caimira
@@ -122,7 +122,7 @@ pip install -e .
122
122
123
123
### Running the Calculator app in development mode
124
124
125
-
In the root directory of the project:
125
+
This example describes how to run the calculator with the CERN-specific UI. In the root directory of the project:
126
126
127
127
```
128
128
python -m cern_caimira.apps.calculator
@@ -150,7 +150,7 @@ Each of these commands will start a local version of CAiMIRA, which can be visit
150
150
151
151
### How to compile and read the documentation
152
152
153
-
In order to generate the documentation, CAiMIRA must be installed first with the `doc` dependencies:
153
+
In order to generate the documentation, CAiMIRA must be installed first with the `doc`optional dependencies:
154
154
155
155
```
156
156
cd caimira
@@ -175,7 +175,7 @@ These applications only work within Jupyter notebooks. Attempting to run them ou
175
175
176
176
##### Prerequisites
177
177
178
-
Make sure you have the needed dependencies intalled:
178
+
Make sure you have the needed dependencies installed:
179
179
180
180
```
181
181
pip install notebook jupyterlab
@@ -191,7 +191,7 @@ Running with Visual Studio Code (VSCode):
191
191
192
192
### Running the tests
193
193
194
-
The project contains test files that separatelly test the functionality of the `caimira` backend and `cern_caimira` UI.
194
+
The project contains test files that separately test the functionality of the `caimira` backend and `cern_caimira` UI.
195
195
196
196
To test the `caimira` package, from the root repository of the project:
197
197
@@ -211,7 +211,7 @@ python -m pytest
211
211
212
212
### Running the profiler
213
213
214
-
The profiler is enabled when the environment variable `CAIMIRA_PROFILER_ENABLED` is set to 1.
214
+
CAiMIRA includes a profiler designed to identify performance bottlenecks. The profiler is enabled when the environment variable `CAIMIRA_PROFILER_ENABLED` is set to 1.
215
215
216
216
When visiting http://localhost:8080/profiler, you can start a new session and choose between [PyInstrument](https://github.com/joerick/pyinstrument) or [cProfile](https://docs.python.org/3/library/profile.html#module-cProfile). The app includes two different profilers, mainly because they can give different information.
217
217
@@ -224,6 +224,7 @@ The sessions are stored in a local file in the `/tmp` folder. To share it across
0 commit comments