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

Update README and Documentation #362

Merged
merged 22 commits into from
Mar 11, 2025
Merged
Changes from 1 commit
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
Prev Previous commit
Apply suggestions from code review
Applied suggested changes

Co-authored-by: Maxence Thévenet <maxence.thevenet@desy.de>
rob-shalloo and MaxThevenet authored Mar 11, 2025
commit eb0659053bd861c426a595ba2a67fe5174098b65
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -13,17 +13,17 @@ For the standard release of the code simply run:
python3 -m pip install lasy
```

If you would prefer the most recent version of the code with the latest functionality, then run:
If you would prefer the most recent version of the code with the latest functionalities, then run:
```
python3 -m pip install git+https://github.com/LASY-org/lasy.git
```

## Tutorials
An interactive Google Colab tutorial showing some of the main functionality of lasy can be found [here](https://colab.research.google.com/drive/1nPwgIUea6Jhzc9CSPDZXCcviWCmebjF1?usp=sharing)
An interactive Google Colab tutorial showing some of the main functionalities of lasy can be found [here](https://colab.research.google.com/drive/1nPwgIUea6Jhzc9CSPDZXCcviWCmebjF1?usp=sharing).

This document is updated on a best effort basis to keep track with developments in the lasy code base.
This document is updated on a best-effort basis to keep track with developments in the lasy code base.

Additionally, a set of static (automatically tested) examples can be found [here](https://lasydoc.readthedocs.io/en/latest/tutorials/index.html)
Additionally, a set of static (automatically tested) examples can be found [here](https://lasydoc.readthedocs.io/en/latest/tutorials/index.html).


## Documentation
6 changes: 3 additions & 3 deletions docs/source/tutorials/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Tutorials
=========

An interactive Google Colab tutorial showing some of the main functionality of lasy can be found `here`_.
An interactive Google Colab tutorial showing some of the main functionalities of lasy can be found `here`_.

.. _here: https://colab.research.google.com/drive/1nPwgIUea6Jhzc9CSPDZXCcviWCmebjF1?usp=sharing

This document is updated on a best effort basis to keep track with developments in the lasy code base.
This document is updated on a best-effort basis to keep track with developments in the lasy code base.

Additionally, a set of static (automatically tested) examples can be found here below:
Additionally, a set of static (automatically tested) examples can be found below:


.. toctree::