Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
15 changes: 0 additions & 15 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,11 @@ env:
# For pushes: github.ref_name is the branch
# For tags: github.ref_name is the tag name
# GITHUB_REPOSITORY - the repository name (used in mkdocs.yml)
# NOTEBOOKS_DIR - the directory containing the Jupyter notebooks (used in mkdocs.yml)
DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
DEVELOP_BRANCH: develop
CI_BRANCH: ${{ github.head_ref || github.ref_name }}
IS_RELEASE_TAG: ${{ startsWith(github.ref, 'refs/tags/v') }}
GITHUB_REPOSITORY: ${{ github.repository }}
NOTEBOOKS_DIR: tutorials
# Opt into Node.js 24 for all JavaScript actions.
# Remove once all referenced actions natively target Node 24.
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true

jobs:
# Single job that builds and deploys documentation.
Expand Down Expand Up @@ -110,16 +105,6 @@ jobs:
- name: Pre-build site step
run: pixi run python -c "import EasyApplication"

# Prepare the Jupyter notebooks for documentation (strip output, etc.).
- name: Prepare notebooks
run: pixi run notebook-prepare

# Execute all Jupyter notebooks to generate output cells (plots, tables, etc.).
# Uses multiple cores for parallel execution to speed up the process.
- name: Run notebooks
# if: false # Temporarily disabled to speed up the docs build
run: pixi run notebook-exec

# Build the static files for the documentation site for local inspection
# Input: docs/ directory containing the Markdown files
# Output: site/ directory containing the generated HTML files
Expand Down
8 changes: 0 additions & 8 deletions .github/workflows/lint-format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,6 @@ jobs:
shell: bash
run: pixi run nonpy-format-check

- name: Check linting of Python code in Jupyter notebooks (ipynb)
id: notebook_lint
continue-on-error: true
shell: bash
run: pixi run notebook-lint-check

# Add summary
- name: Add quality checks summary
if: always()
Expand All @@ -110,7 +104,6 @@ jobs:
echo "| py format | ${{ steps.py_format.outcome == 'success' && '✅' || '❌' }} |"
echo "| docstring lint | ${{ steps.docstring_lint.outcome == 'success' && '✅' || '❌' }} |"
echo "| nonpy format | ${{ steps.nonpy_format.outcome == 'success' && '✅' || '❌' }} |"
echo "| notebooks lint | ${{ steps.notebook_lint.outcome == 'success' && '✅' || '❌' }} |"
} >> "$GITHUB_STEP_SUMMARY"

# Fail job if any check failed
Expand All @@ -122,6 +115,5 @@ jobs:
|| steps.py_format.outcome == 'failure'
|| steps.docstring_lint.outcome == 'failure'
|| steps.nonpy_format.outcome == 'failure'
|| steps.notebook_lint.outcome == 'failure'
shell: bash
run: exit 1
45 changes: 0 additions & 45 deletions .github/workflows/tutorial-tests-trigger.yml

This file was deleted.

63 changes: 0 additions & 63 deletions .github/workflows/tutorial-tests.yml

This file was deleted.

7 changes: 0 additions & 7 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,6 @@ repos:
pass_filenames: false
stages: [manual]

- id: pixi-notebook-lint-check
name: pixi run notebook-lint-check
entry: pixi run notebook-lint-check
language: system
pass_filenames: false
stages: [manual]

- id: pixi-unit-tests
name: pixi run unit-tests
entry: pixi run unit-tests
Expand Down
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,7 @@ based on the EasyScience framework.

<!-- HOME REPOSITORY SECTION -->

**EasyApplication** is developed as a Python library.

License:
[BSD 3-Clause](https://github.com/easyscience/easyapp/blob/master/LICENSE)
**EasyApplication** is distributed as a Python package.

License:
[BSD 3-Clause](https://github.com/easyscience/gui-components/blob/master/LICENSE)
Expand All @@ -31,8 +28,6 @@ License:
[Documentation](https://easyscience.github.io/gui-components/latest)
- 🚀
[Getting Started](https://easyscience.github.io/gui-components/latest/introduction)
- 🧪
[Tutorials](https://easyscience.github.io/gui-components/latest/tutorials)
- 💬
[Get in Touch](https://easyscience.github.io/gui-components/latest/introduction/#get-in-touch)
- 🧾
Expand Down
3 changes: 1 addition & 2 deletions docs/docs/api-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ icon: material/code-braces-box

# :material-code-braces-box: API Reference

This section contains the reference detailing the functions and modules
available in EasyApplication.
To be added.
160 changes: 0 additions & 160 deletions docs/docs/installation-and-setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,93 +7,6 @@ icon: material/cog-box
**EasyApplication** is a cross-platform Python library compatible with
**Python 3.12** through **3.14**.

To install and set up EasyApplication, we recommend using
[**Pixi**](https://pixi.prefix.dev), a modern package manager for
Windows, macOS, and Linux.

??? note "Main benefits of using Pixi"

- **Ease of use**: Pixi simplifies the installation process, making it
accessible even for users with limited experience in package management.
- **Python version control**: Pixi allows specifying and managing different
Python versions for each project, ensuring compatibility.
- **Isolated environments**: Pixi creates isolated environments for each
project, preventing conflicts between different package versions.
- **PyPI and Conda support**: Pixi can install packages from both PyPI and
Conda repositories, providing access to a wide range of libraries.

An alternative installation method using the traditional **pip** package
manager is also provided.

## Installing with Pixi <small>recommended</small> { #installing-with-pixi data-toc-label="Installing with Pixi" }

This section describes the simplest way to set up EasyApplication using
**Pixi**.

#### Installing Pixi

- Install Pixi by following the instructions on the
[official Pixi Installation Guide](https://pixi.prefix.dev/latest/installation).

#### Setting up EasyApplication with Pixi

<!-- prettier-ignore-start -->

- Choose a project location (local drive recommended).

??? warning ":fontawesome-brands-windows: Windows + OneDrive"

We **do not recommend creating a Pixi project inside OneDrive or other
synced folders**.

By default, Pixi creates the virtual environment inside the project
directory (in `.pixi/`). On Windows, synced folders such as OneDrive
may cause file‑system issues (e.g., path-length limitations or
restricted link operations), which can lead to unexpected install
errors or environments being recreated.

Instead, create your project in a **local directory on your drive**
where you have full write permissions.

<!-- prettier-ignore-end -->

- Initialize a new Pixi project and navigate into it:
```txt
pixi init EasyApplication
cd EasyApplication
```
- Set the Python version for the Pixi environment (e.g., 3.14):
```txt
pixi add python=3.14
```
- Add EasyApplication to the Pixi environment from PyPI:
```txt
pixi add --pypi EasyApplication
```
- Add a Pixi task to run EasyApplication commands easily:
```txt
pixi task add EasyApplication "python -m EasyApplication"
```

#### Updating Pixi and EasyApplication

- To update all packages in the Pixi environment, including
EasyApplication:
```txt
pixi update
```
- To update Pixi itself to the latest version:
```txt
pixi self-update
```

#### Uninstalling Pixi

- Follow the
[official Pixi Guide](https://pixi.prefix.dev/latest/installation/#uninstall).

## Classical Installation

This section describes how to install EasyApplication using the
traditional method with **pip**. It is assumed that you are familiar
with Python package management and virtual environments.
Expand Down Expand Up @@ -210,76 +123,3 @@ To include extra dependencies (e.g., dev):
```txt
pip install 'EasyApplication[dev] @ git+https://github.com/easyscience/gui-components@develop'
```

## How to Run Tutorials

EasyApplication includes a collection of **Jupyter Notebook examples**
that demonstrate key functionality. These tutorials serve as
**step-by-step guides** to help users understand the data analysis
workflow. They are available as **static HTML pages** in the
[:material-school: Tutorials](../tutorials/index.md) section.

In the next sections, we explain how to set up Jupyter and run the
tutorials interactively in two different ways: locally or online via
Google Colab.

If you decide to run the tutorials locally, you need to download them
first. This can be done individually via the :material-download:
**Download Notebook** button available on each tutorial page, or all at
once using the command line, as shown below.

### Run Tutorials Locally with Pixi <small>recommended</small> { #running-with-pixi data-toc-label="Run Tutorials Locally with Pixi" }

- Navigate to your existing Pixi project, created as described in the
[Installing with Pixi](#installing-with-pixi) section.
- Add JupyterLab and the Pixi kernel for Jupyter:
```txt
pixi add --pypi jupyterlab pixi-kernel
```
- Download all the EasyApplication tutorials to the `tutorials/`
directory:
```txt
pixi run EasyApplication download-all-tutorials
```
- Start JupyterLab in the `tutorials/` directory to access the
notebooks:
```txt
pixi run jupyter lab tutorials/
```
- Your web browser should open automatically. Click on one of the
`*.ipynb` files and select the `Python (Pixi)` kernel to get started.

### Classical Run Tutorials Locally

- Install Jupyter Notebook and IPython kernel:
```txt
pip install notebook ipykernel
```
- Add the virtual environment as a Jupyter kernel:
```txt
python -m ipykernel install --user --name=venv --display-name "EasyApplication Python kernel"
```
- Download all the EasyApplication tutorials to the `tutorials/`
directory:
```txt
python -m EasyApplication download-all-tutorials
```
- Launch the Jupyter Notebook server (opens browser automatically at
`http://localhost:8888/`):
```txt
jupyter notebook tutorials/
```
- Open one of the `*.ipynb` files and select the
`EasyApplication Python kernel` to get started.

### Run Tutorials via Google Colab

**Google Colab** lets you run Jupyter Notebooks in the cloud without any
local installation. This is the fastest way to start experimenting with
EasyApplication.

- Ensure you have a **Google account**.
- Go to the **[:material-school: Tutorials](../tutorials/index.md)**
section.
- Click the :google-colab: **Open in Google Colab** button on any
tutorial.
Loading
Loading