Added correct version and updated readme
This commit is contained in:
parent
ecdbb1c2b3
commit
fcbfdf2eae
2 changed files with 17 additions and 3 deletions
18
README.md
18
README.md
|
|
@ -146,11 +146,25 @@ Then, right click on `caimira/docs/_build/html/index.html` and select `Open with
|
||||||
The `ExpertApplication` and `CO2Application` are no longer actively maintained but will remain in the codebase for legacy purposes.
|
The `ExpertApplication` and `CO2Application` are no longer actively maintained but will remain in the codebase for legacy purposes.
|
||||||
Please note that the functionality of these applications might be compromised due to deprecation issues.
|
Please note that the functionality of these applications might be compromised due to deprecation issues.
|
||||||
|
|
||||||
##### Running the Applications
|
#### Running the Applications
|
||||||
|
|
||||||
These applications only work within Jupyter notebooks. Attempting to run them outside of a Jupyter environment may result in errors or degraded functionality.
|
These applications only work within Jupyter notebooks. Attempting to run them outside of a Jupyter environment may result in errors or degraded functionality.
|
||||||
|
|
||||||
<!-- TODO: ADD EXPLANATION ON HOW TO RUN WITH JUPYTER -->
|
##### Prerequisites
|
||||||
|
|
||||||
|
Make sure you have the needed dependencies intalled:
|
||||||
|
|
||||||
|
```
|
||||||
|
pip install notebook jupyterlab
|
||||||
|
```
|
||||||
|
|
||||||
|
Running with Visual Studio Code (VSCode):
|
||||||
|
|
||||||
|
1. Ensure you have the following extensions installed in VSCode: `Jupyter` and `Python`.
|
||||||
|
|
||||||
|
2. Open VSCode and navigate to the directory containing the notebook.
|
||||||
|
|
||||||
|
3. Open the notebook (e.g. `caimira/apps/expert/caimira.ipynb`) and run the cells by clicking the `run` button next to each cell.
|
||||||
|
|
||||||
### Running the tests
|
### Running the tests
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
|
|
||||||
<div class="container container--padding" style="word-wrap:break-word";>
|
<div class="container container--padding" style="word-wrap:break-word";>
|
||||||
|
|
||||||
<h1 class="paragraph-title">CAiMIRA Expert Apps were deprecated in version 5.16.0</h1><br>
|
<h1 class="paragraph-title">CAiMIRA Expert Apps were deprecated in version 4.16.0</h1><br>
|
||||||
|
|
||||||
With the latest feature implementations in the core CAiMIRA engine, the <b>ExpertApplication</b> and <b>CO2Application</b> apps are no longer actively maintained.
|
With the latest feature implementations in the core CAiMIRA engine, the <b>ExpertApplication</b> and <b>CO2Application</b> apps are no longer actively maintained.
|
||||||
For legacy purposes, the source code is still available in the <a href="https://gitlab.cern.ch/caimira/caimira/">GitLab</a> repository.
|
For legacy purposes, the source code is still available in the <a href="https://gitlab.cern.ch/caimira/caimira/">GitLab</a> repository.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue