Skip to content

Commit 73bed86

Browse files
committed
update root README and remove other READMEs
1 parent cfb63ae commit 73bed86

File tree

5 files changed

+11
-475
lines changed

5 files changed

+11
-475
lines changed

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
CAiMIRA is a risk assessment tool developed to model the concentration of viruses in enclosed spaces, in order to inform space-management decisions.
44

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.
66
The user can set a number of parameters, including room volume, exposure time, activity type, mask-wearing and ventilation.
77
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.
88

@@ -94,8 +94,8 @@ This will start a local version of CAiMIRA, which can be visited at http://local
9494

9595
The project contains two different Python packages:
9696

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.
9999

100100
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/).
101101

@@ -106,14 +106,14 @@ CAiMIRA is also mirrored to Github if you wish to collaborate on development and
106106

107107
### Installing CAiMIRA in editable mode
108108

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:
110110

111111
```
112112
cd caimira
113113
pip install -e .
114114
```
115115

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:
117117

118118
```
119119
cd cern_caimira
@@ -122,7 +122,7 @@ pip install -e .
122122

123123
### Running the Calculator app in development mode
124124

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:
126126

127127
```
128128
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
150150

151151
### How to compile and read the documentation
152152

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:
154154

155155
```
156156
cd caimira
@@ -175,7 +175,7 @@ These applications only work within Jupyter notebooks. Attempting to run them ou
175175

176176
##### Prerequisites
177177

178-
Make sure you have the needed dependencies intalled:
178+
Make sure you have the needed dependencies installed:
179179

180180
```
181181
pip install notebook jupyterlab
@@ -191,7 +191,7 @@ Running with Visual Studio Code (VSCode):
191191

192192
### Running the tests
193193

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.
195195

196196
To test the `caimira` package, from the root repository of the project:
197197

@@ -211,7 +211,7 @@ python -m pytest
211211

212212
### Running the profiler
213213

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.
215215

216216
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.
217217

@@ -224,6 +224,7 @@ The sessions are stored in a local file in the `/tmp` folder. To share it across
224224
From the root directory of the project:
225225

226226
1. Run the backend API:
227+
227228
```
228229
python -m caimira.api.app
229230
```

caimira/README.md

Whitespace-only changes.

caimira/pyproject.toml

-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ build-backend = "setuptools.build_meta"
66
name = "caimira"
77
version = "2.0.0"
88
description = "CAiMIRA - CERN Airborne Model for Indoor Risk Assessment"
9-
readme = "README.md"
109
license = { text = "Apache-2.0" }
1110
authors = [
1211
{ name = "Andre Henriques", email = "[email protected]" }

0 commit comments

Comments
 (0)