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

Fixes #180

Merged
merged 50 commits into from
Dec 18, 2024
Merged

Fixes #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
e063b7f
docs fixes
LonnekeScheffer Nov 19, 2024
6584027
print dataset stats after preprocessing
LonnekeScheffer Nov 19, 2024
0048897
when makng random repertoire: add random counts (helpful for testing …
LonnekeScheffer Nov 19, 2024
09746ef
better display sequence count distribution: add locus facet for seque…
LonnekeScheffer Nov 19, 2024
d9b0fc0
remove distracting extra newlines in logging warning when importing data
LonnekeScheffer Nov 19, 2024
79208ec
add region type to one hot encoder; cdr3 by default
pavlovicmilena Nov 19, 2024
36adea5
convert boolean values to 'T'/'F' in import, default bool value is ''…
LonnekeScheffer Nov 21, 2024
8a33871
Data import updates:
LonnekeScheffer Nov 21, 2024
4026ba3
use default params loader in airr test
LonnekeScheffer Nov 21, 2024
1d41e99
bugfix separator tenxgenomics
LonnekeScheffer Nov 29, 2024
7279fec
clearer error logging in Report
LonnekeScheffer Nov 29, 2024
1cb5bb1
Use logging.warning instead of warnings.warn; the latter does not sho…
LonnekeScheffer Nov 29, 2024
495b838
VJ gene dist report updates:
LonnekeScheffer Dec 3, 2024
726cbac
minor fix in error VJGeneDistribution.py
LonnekeScheffer Dec 3, 2024
6a8061c
minor fix in VJGeneDistribution.py
LonnekeScheffer Dec 3, 2024
1fd7b82
better logging/errors when importing repertoires + keep repertoire id…
LonnekeScheffer Dec 3, 2024
20d236c
add cdr3 as output to ligo
pavlovicmilena Dec 9, 2024
e7288d8
Merge remote-tracking branch 'origin/fixes' into fixes
pavlovicmilena Dec 9, 2024
3dd2c23
add cdr3 from junction; standardize region type with gen models
pavlovicmilena Dec 10, 2024
3bd9106
minor bugfix
LonnekeScheffer Dec 10, 2024
04d9485
fix tests
pavlovicmilena Dec 11, 2024
746f343
Merge remote-tracking branch 'origin/fixes' into fixes
pavlovicmilena Dec 11, 2024
c2b8478
fix VAE region type
pavlovicmilena Dec 15, 2024
6f848ba
update requirements:
LonnekeScheffer Dec 16, 2024
f139607
requirements: change < to <= as it sometimes does not recognize < cor…
LonnekeScheffer Dec 16, 2024
4192659
update dependency version restrictions in setup.py
LonnekeScheffer Dec 16, 2024
f542448
fix test_compAIRRDistanceEncoder.py: now, duplicate_counts are random…
LonnekeScheffer Dec 16, 2024
d052b82
Fix tests for matches report and related encoder:
LonnekeScheffer Dec 16, 2024
c764d20
bugfix in test_vae_summary.py (SimpleVAE must always be applied to ju…
LonnekeScheffer Dec 16, 2024
61292a6
fix in test_fit_apply_gen_model: always use IMGT_Junction
LonnekeScheffer Dec 16, 2024
9e72785
undo comment shutil.rmtree
LonnekeScheffer Dec 16, 2024
2b75e9d
import-related class documentation updates
LonnekeScheffer Dec 16, 2024
be78842
add failed html image for docs
LonnekeScheffer Dec 16, 2024
1ebaf3c
Merge remote-tracking branch 'origin/fixes' into fixes
LonnekeScheffer Dec 16, 2024
8b77fb6
docs updates: preferred python version
LonnekeScheffer Dec 16, 2024
0010f2e
Merge remote-tracking branch 'origin/fixes' into fixes
LonnekeScheffer Dec 16, 2024
52bafab
new metadata file showing identifier column
LonnekeScheffer Dec 17, 2024
19a51e3
Merge remote-tracking branch 'origin/fixes' into fixes
LonnekeScheffer Dec 17, 2024
7792e55
update docs "how to import data in immuneml"
LonnekeScheffer Dec 17, 2024
d5736e7
update galaxy intro docs
LonnekeScheffer Dec 17, 2024
38cd45b
update clustering galaxy tool api
pavlovicmilena Dec 17, 2024
a634ef4
update clustering galaxy tool api
pavlovicmilena Dec 17, 2024
78b5055
add galaxy_history_elements.png
LonnekeScheffer Dec 17, 2024
2c1be3f
Merge remote-tracking branch 'origin/fixes' into fixes
LonnekeScheffer Dec 17, 2024
a1c2a09
updated galaxy related docs
LonnekeScheffer Dec 17, 2024
312f7ec
made specification docs easier to navigate, removed clutter
LonnekeScheffer Dec 18, 2024
3e00671
formatting reports/ml method subgroups in docs
LonnekeScheffer Dec 18, 2024
b57c954
switch to 'avant' Galaxy url in docs + remove references to any histo…
LonnekeScheffer Dec 18, 2024
7826e11
fix reference to figures from reports and ML methods
LonnekeScheffer Dec 18, 2024
69bfe3a
Update version
pavlovicmilena Dec 18, 2024
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
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,11 @@ Useful links:


We recommend installing immuneML inside a virtual environment.
immuneML uses Python 3.8 or later. If using immuneML simulation, Python 3.11 or later is recommended.

immuneML uses **Python 3.9 or later**. If using immuneML simulation, Python 3.11 or later is recommended.
immuneML can be [installed directly using a package manager](<https://docs.immuneml.uio.no/latest/installation/install_with_package_manager.html#>) such as pip or conda,
or [set up via docker](<https://docs.immuneml.uio.no/latest/installation/installation_docker.html>).

Quick installation:
#### Quick installation (immuneML essentials):

```bash
python3 -m venv ./immuneml_venv/
Expand All @@ -47,11 +46,13 @@ pip install immune-ml
or

```bash
conda create --prefix immuneml_env/ python=3.8
conda create --prefix immuneml_env/ python=3.11
conda activate immuneml_env/
conda install -c bioconda immuneml
```

#### Detailed installation (immuneML extras):

Please check the documentation for more detailed instructions or [how to install optional dependencies](<https://docs.immuneml.uio.no/latest/installation/install_with_package_manager.html#installing-optional-dependencies>).

### Validating the installation
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/images/metadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/source/developer_docs/install_for_development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Prerequisites

- System requirements: at least 4GB of RAM memory and 15GB of disk space.

- A Python virtual environment using at least Python version 3.8 (newest version of Python is usually recommended). This can be created through `Python venv <https://docs.python.org/3/library/venv.html>`_ or `conda venv <https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html>`_.
- A Python virtual environment using **at least Python version 3.9** (newest version of Python is usually recommended). This can be created through `Python venv <https://docs.python.org/3/library/venv.html>`_ or `conda venv <https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html>`_.

- Under Windows, the Microsoft Visual C++ 14.0 or greater is required to install from requirements.txt.

Expand Down
35 changes: 8 additions & 27 deletions docs/source/galaxy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,18 @@ immuneML & Galaxy
:twitter:image: https://docs.immuneml.uio.no/_images/receptor_classification_overview.png


All of immuneMLs functionalities are also available through `a Galaxy web interface <https://galaxy.immuneml.uiocloud.no>`_ as a collection of Galaxy tools. We provide a YAML-based Galaxy
tool that is equivalent to the CLI (command-line interface), as well as repertoire and receptor-level classification tools with an intuitive
graphical user interface aimed at immunology experts without a machine learning background.

All of immuneMLs functionalities are also available through `a Galaxy web interface <https://avant.immuneml.uiocloud.no>`_ as a collection of Galaxy tools.
The immuneML Galaxy tools provide simplified, button-based interfaces to get started running different types of immuneML analyses,
or can alternatively be run with a YAML input file to specify all parameters.

.. toctree::
:maxdepth: 1
:caption: Galaxy tutorial
:caption: Galaxy tutorials

galaxy/galaxy_intro
galaxy/galaxy_tools
galaxy/galaxy_immunologist_friendly

.. toctree::
:maxdepth: 1
:caption: Galaxy dataset tutorials:

galaxy/galaxy_dataset
galaxy/galaxy_import_remote_data
galaxy/galaxy_simulate_dataset
galaxy/galaxy_simulate_signals

.. toctree::
:maxdepth: 1
:caption: Galaxy simple analysis tutorials:

galaxy/galaxy_simple_receptors
galaxy/galaxy_simple_repertoires

.. toctree::
:maxdepth: 1
:caption: Galaxy advanced analysis tutorials:

galaxy/galaxy_train_ml_models
galaxy/galaxy_general_yaml
..
_Note: galaxy_import_remote_data is currently not linked in the docs, should be linked once those tools are made available on new galaxy server

67 changes: 0 additions & 67 deletions docs/source/galaxy/galaxy_apply_ml_models.rst

This file was deleted.

222 changes: 0 additions & 222 deletions docs/source/galaxy/galaxy_dataset.rst

This file was deleted.

Loading
Loading