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

Guidelines update #48

Merged
merged 23 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
dab785e
Adding phenotrack citation + updating skan functions to 0.11+
AurelienBesnier Oct 17, 2024
6380968
Saving npz file with python 3
AurelienBesnier Oct 18, 2024
4acd5be
Updating skan fcts to 0.11
AurelienBesnier Oct 18, 2024
589ce38
Formatting with ruff + typo fixes in documentation + removing unneede…
AurelienBesnier Oct 18, 2024
50d9ccc
Modernizing test suite + adding more tests
AurelienBesnier Oct 18, 2024
133c390
Merge branch 'openalea:master' into master
AurelienBesnier Oct 21, 2024
213e3e5
Update README.md
AurelienBesnier Oct 21, 2024
1fb074b
Update README.md
AurelienBesnier Oct 21, 2024
6599430
[no ci] Update README + update version
AurelienBesnier Oct 30, 2024
57a634d
Adding CHANGELOG.md + update documentation config
AurelienBesnier Nov 19, 2024
4e0a0ff
Update meta.yaml
AurelienBesnier Nov 19, 2024
6339115
Adding pyproject.toml
AurelienBesnier Nov 19, 2024
7b04c18
Adding restriction of numpy in pyproject.toml
AurelienBesnier Nov 19, 2024
660b4ed
changing minimum python version in pyproject.toml
AurelienBesnier Nov 19, 2024
eb8c2ed
Adding comment for future upgrades
AurelienBesnier Nov 20, 2024
5a25f78
[no ci] updating code to respect guidelines
AurelienBesnier Nov 20, 2024
d2d12a7
Fixing location of example data
AurelienBesnier Nov 20, 2024
7fdb9d2
Adding missing deps for documentation
AurelienBesnier Nov 20, 2024
eb2c2a3
removing breaking numba jit
AurelienBesnier Nov 20, 2024
41da32f
Formatting + fixing maize analysis functions
AurelienBesnier Nov 21, 2024
57efb1a
Updating some outdated notebook functions
AurelienBesnier Nov 21, 2024
3cdcc84
Updating some outdated notebook functions
AurelienBesnier Nov 21, 2024
ff1e9c3
Merge branch 'master' into master
AurelienBesnier Dec 3, 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
30 changes: 30 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- A `pyproject.toml` file.
- This CHANGELOG.md file.
- Phenotrack citation in [README.md](./README.md) (#44).
- [OpenAlea svg](./doc/_static/openalea_web.svg) logo for documentation.
- More test for the test suite.

### Changed

- The documentation configuration file `conf.py` with [OpenAlea Guidelines](https://openalea.readthedocs.io/en/latest/development/guidelines.html).
- Modernized the test suite.
- Compatibility with numpy 2.0.
- Updated code to respect guidelines.
- Formating source files with [ruff](https://docs.astral.sh/ruff/).

### Fixed

- Updating skan function to more recent versions.
- Removed warning of test files saved with python 2 by saving them again with python 3.
- Fixing location of data for notebook examples.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Last version](https://anaconda.org/openalea3/openalea.phenomenal/badges/version.svg)](https://anaconda.org/OpenAlea3/openalea.phenomenal/files)
[![GitHub CI](https://github.com/openalea/phenomenal/actions/workflows/conda-package-build.yml/badge.svg)](https://github.com/openalea/phenomenal/actions/workflows/conda-package-build.yml)
[![Documentation Status](https://readthedocs.org/projects/phenomenal/badge/?version=latest)](https://phenomenal.readthedocs.io/en/latest/?badge=latest)
[![aunch interactive phenomenal notebook with myBinder service](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/openalea/phenomenal/master?filepath=examples)
[![Launch interactive phenomenal notebook with myBinder service](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/openalea/phenomenal/master?filepath=examples)


## Phenomenal: An automatic open source library for 3D shoot architecture reconstruction and analysis for image-based plant phenotyping
Expand All @@ -31,21 +31,42 @@ If you find our work useful in your research, please consider citing:
journal = {bioRxiv}
}

If you use PhenoTrack3D in your research, cite:

Daviet, B., Fernandez, R., Cabrera-Bosquet, L. et al. PhenoTrack3D: an automatic high-throughput phenotyping pipeline to track maize organs over time. Plant Methods 18, 130 (2022). https://doi.org/10.1186/s13007-022-00961-4

```latex
@article {daviet22,
author = {Daviet, Benoit and Fernandez, Romain and Cabrera-Bosquet, Lloren{\c c} and Pradal, Christophe and Fournier, Christian},
title = {PhenoTrack3D: an automatic high-throughput phenotyping pipeline to track maize organs over time},
elocation-id = @article{daviet2022phenotrack3d,
title={PhenoTrack3D: an automatic high-throughput phenotyping pipeline to track maize organs over time},
author={Daviet, Benoit and Fernandez, Romain and Cabrera-Bosquet, Lloren{\c{c}} and Pradal, Christophe and Fournier, Christian},
journal={Plant Methods},
volume={18},
number={1},
pages={1--14},
year={2022},
publisher={Springer}
}

```


### Installation

Conda environement : https://docs.conda.io/en/latest/index.html
Conda environment : https://docs.conda.io/en/latest/index.html

#### User

##### Create a new environment with phenomenal installed in there :

mamba create -n phm -c conda-forge -c openalea openalea.phenomenal
mamba create -n phm -c conda-forge -c openalea3 openalea.phenomenal
mamba activate phm

##### In a existing environment :

mamba install -c conda-forge -c openalea openalea.phenomenal
mamba install -c conda-forge -c openalea3 openalea.phenomenal

##### (Optional) Test your installation :

Expand All @@ -58,7 +79,7 @@ Conda environement : https://docs.conda.io/en/latest/index.html
# Install dependency with conda
mamba create -n phm -c conda-forge python
mamba activate phm
mamba install -c conda-forge -c numba cython numpy numba scipy scikit-image scikit-learn networkx opencv matplotlib vtk pytest skan=0.10
mamba install -c conda-forge cython numpy numba scipy scikit-image scikit-learn networkx opencv matplotlib vtk pytest skan

# Load phenomenal and install
git clone https://github.com/openalea/phenomenal.git
Expand Down
4 changes: 2 additions & 2 deletions conda/meta.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package:
name: openalea.phenomenal
version: "1.9.3"
version: "1.9.4"

source:
path: ..
Expand Down Expand Up @@ -42,7 +42,7 @@ requirements:
- opencv >4.1.2 [osx]
- matplotlib
- vtk
- skan>=0.10
- skan
- pywin32 [win]

test:
Expand Down
108 changes: 108 additions & 0 deletions doc/_static/openalea_web.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading