Skip to content

updated README.md #438

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.

Sign up for GitHub

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

Merged
rozyczko merged 2 commits into from
Oct 14, 2026
Merged

updated README.md #438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0b10f8
updated README.md
rozyczko Oct 12, 2026
b29a956
slight modifications of README
rozyczko Oct 13, 2026
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
114 changes: 0 additions & 114 deletions CONTRIBUTING.rst
View file
Open in desktop

This file was deleted.

38 changes: 33 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,41 @@
</picture>
</p>

**EasyReflectometry** is a software for performing reflectometry
calculations based on a layer model and refining its parameters against
reflectometry data.
**EasyReflectometry** is a Python library for simulating reflectometry
profiles from layered sample models and refining their parameters
against experimental data.

It supports multiple contrasts and simultaneous fitting, polarised
reflectometry channels, Bayesian (MCMC) analysis, ORSO data and model
import/export, and a choice of calculation engines (refnx or refl1d).

<!-- HOME REPOSITORY SECTION -->

**EasyReflectometry** is developed as a Python library.
**EasyReflectometry** is built on the
[EasyScience framework](https://easyscience.org) and maintained by the
[European Spallation Source (ESS)](https://ess.eu).

## Installation

**EasyReflectometry** requires Python 3.11–3.13 and is available on
PyPI:

```bash
pip install easyreflectometry
```

The `dev` extra is only needed if you want to contribute to the library
or build the documentation. It adds the tooling for testing (pytest),
linting and formatting (ruff, pre-commit), building the docs (mkdocs)
and running the tutorial notebooks. To install it from PyPI:

```bash
pip install 'easyreflectometry[dev]'
```

See the
[Installation & Setup](https://easyscience.github.io/reflectometry-lib/latest/installation-and-setup)
guide for the recommended Pixi-based setup.

License:
[BSD 3-Clause](https://github.com/easyscience/reflectometry-lib/blob/master/LICENSE)
Expand All @@ -27,7 +55,7 @@ License:
- 📖
[Documentation](https://easyscience.github.io/reflectometry-lib/latest)
- 🚀
[Getting Started](https://easyscience.github.io/reflectometry-lib/latest/introduction)
[Getting Started](https://easyscience.github.io/reflectometry-lib/latest/installation-and-setup)
- 🧪
[Tutorials](https://easyscience.github.io/reflectometry-lib/latest/tutorials)
- 💬
Expand Down
2 changes: 1 addition & 1 deletion pixi.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,10 @@ dependencies = [
'asteval',
'pooch',
'plotly',
'h5py',
]

[project.optional-dependencies]
# Binary ORSO (.orb / NeXus) read and write support (orsopy uses h5py for it)
orb = ['h5py']
dev = [
'GitPython', # Interact with Git repositories
'build', # Building the package
Expand Down
Loading