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 contribution notes #66

Merged
merged 24 commits into from
Jun 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
925bd97
initial draft
yfukai Jun 1, 2022
e3c0457
added git version for the original
yfukai Jun 1, 2022
8cc283b
:busts_in_silhouette: Add @yfukai as a contributor
yfukai Jun 1, 2022
0e0fad3
:busts_in_silhouette: Update @yfukai as a contributor
yfukai Jun 1, 2022
10f45d9
:busts_in_silhouette: Update @yfukai as a contributor
yfukai Jun 1, 2022
6c17894
:busts_in_silhouette: Update @yfukai as a contributor
yfukai Jun 1, 2022
7596449
:busts_in_silhouette: Update @yfukai as a contributor
yfukai Jun 1, 2022
f31f7a4
:busts_in_silhouette: Add @tying84 as a contributor
yfukai Jun 1, 2022
9a5c90a
:busts_in_silhouette: Update @tying84 as a contributor
yfukai Jun 1, 2022
598725f
:busts_in_silhouette: Update @tying84 as a contributor
yfukai Jun 1, 2022
a78ba6e
:busts_in_silhouette: Add @tdmorello as a contributor
yfukai Jun 1, 2022
374ccaa
:busts_in_silhouette: Update @tdmorello as a contributor
yfukai Jun 1, 2022
567a2ce
:busts_in_silhouette: Update @tdmorello as a contributor
yfukai Jun 1, 2022
d287305
:busts_in_silhouette: Add @Nicholas-Schaub as a contributor
yfukai Jun 1, 2022
0e1f027
:busts_in_silhouette: Update @Nicholas-Schaub as a contributor
yfukai Jun 1, 2022
569f832
:busts_in_silhouette: Update @Nicholas-Schaub as a contributor
yfukai Jun 1, 2022
f30447d
:busts_in_silhouette: Update @Nicholas-Schaub as a contributor
yfukai Jun 1, 2022
01b4b17
:busts_in_silhouette: Update @Nicholas-Schaub as a contributor
yfukai Jun 1, 2022
c24572e
trying to see how all-contributors works
yfukai Jun 1, 2022
1c6bac6
reordered contributors
yfukai Jun 1, 2022
6dd0167
regenerated readme
yfukai Jun 1, 2022
f55d737
commenting on contrinbution
yfukai Jun 1, 2022
372b996
organized README
yfukai Jun 1, 2022
30ea812
updated nick email, added contributions to Tingying
yfukai Jun 13, 2022
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
65 changes: 65 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"projectName": "BaSiCPy",
"projectOwner": "peng-lab",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 100,
"commit": true,
"commitConvention": "gitmoji",
"contributors": [
{
"login": "Nicholas-Schaub",
"name": "Nicholas-Schaub",
"avatar_url": "https://avatars.githubusercontent.com/u/15925882?v=4",
"profile": "https://github.com/Nicholas-Schaub",
"contributions": [
"code",
"test",
"review",
"ideas",
"projectManagement"
]
},
{
"login": "tdmorello",
"name": "Tim Morello",
"avatar_url": "https://avatars.githubusercontent.com/u/34800427?v=4",
"profile": "https://github.com/tdmorello",
"contributions": [
"review",
"test",
"ideas",
"code"
]
},
{
"login": "tying84",
"name": "Tingying Peng",
"avatar_url": "https://avatars.githubusercontent.com/u/11461947?v=4",
"profile": "https://github.com/tying84",
"contributions": [
"code",
"data",
"financial",
"talk"
]
},
{
"login": "yfukai",
"name": "Yohsuke T. Fukai",
"avatar_url": "https://avatars.githubusercontent.com/u/5919272?v=4",
"profile": "https://github.com/yfukai",
"contributions": [
"code",
"research",
"question",
"test",
"ideas"
]
}
],
"contributorsPerLine": 7
}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,4 @@ cython_debug/
.vscode/
.DS_Store
scratch/
node_modules/
48 changes: 46 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# BaSiCPy

A python package for background and shading correction of optical microscopy images

[![License](https://img.shields.io/pypi/l/python-basic.svg)](https://github.com/napari/napari/raw/main/LICENSE)
[![Python Version](https://img.shields.io/pypi/pyversions/python-basic.svg)](https://python.org)
[![PyPI](https://img.shields.io/pypi/v/python-basic.svg)](https://pypi.org/project/python-basic)
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

BaSiCPy is a python package for background and shading correction of optical microscopy images. It is developed based on the Matlab version of [BaSiC](https://github.com/marrlab/BaSiC) tool.

Expand Down Expand Up @@ -58,3 +59,46 @@ python -m venv venv
source venv/bin/activate
pip install -e '.[dev]'
```

## Contributors

### Current version
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/Nicholas-Schaub"><img src="https://avatars.githubusercontent.com/u/15925882?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nicholas-Schaub</b></sub></a><br /><a href="https://github.com/peng-lab/BaSiCPy/commits?author=Nicholas-Schaub" title="Code">💻</a> <a href="https://github.com/peng-lab/BaSiCPy/commits?author=Nicholas-Schaub" title="Tests">⚠️</a> <a href="https://github.com/peng-lab/BaSiCPy/pulls?q=is%3Apr+reviewed-by%3ANicholas-Schaub" title="Reviewed Pull Requests">👀</a> <a href="#ideas-Nicholas-Schaub" title="Ideas, Planning, & Feedback">🤔</a> <a href="#projectManagement-Nicholas-Schaub" title="Project Management">📆</a></td>
<td align="center"><a href="https://github.com/tdmorello"><img src="https://avatars.githubusercontent.com/u/34800427?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tim Morello</b></sub></a><br /><a href="https://github.com/peng-lab/BaSiCPy/pulls?q=is%3Apr+reviewed-by%3Atdmorello" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/peng-lab/BaSiCPy/commits?author=tdmorello" title="Tests">⚠️</a> <a href="#ideas-tdmorello" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/peng-lab/BaSiCPy/commits?author=tdmorello" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/tying84"><img src="https://avatars.githubusercontent.com/u/11461947?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tingying Peng</b></sub></a><br /><a href="https://github.com/peng-lab/BaSiCPy/commits?author=tying84" title="Code">💻</a> <a href="#data-tying84" title="Data">🔣</a> <a href="#financial-tying84" title="Financial">💵</a> <a href="#talk-tying84" title="Talks">📢</a></td>
<td align="center"><a href="https://github.com/yfukai"><img src="https://avatars.githubusercontent.com/u/5919272?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Yohsuke T. Fukai</b></sub></a><br /><a href="https://github.com/peng-lab/BaSiCPy/commits?author=yfukai" title="Code">💻</a> <a href="#research-yfukai" title="Research">🔬</a> <a href="#question-yfukai" title="Answering Questions">💬</a> <a href="https://github.com/peng-lab/BaSiCPy/commits?author=yfukai" title="Tests">⚠️</a> <a href="#ideas-yfukai" title="Ideas, Planning, & Feedback">🤔</a></td>
</tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
- Nicholas Schaub (@Nicholas-Schaub)
- General mentoring, technology selection and project management
- Designing and implementing core structure of the package
- Code review and advising
- Providing tests
- Tim Morello (@tdmorello)
- Designing and implementing core structure of the package
- Providing tests
- Code review
- Tingying Peng (@tying84)
- General comments and financial support
- Reviewing theoretical calculation
- Providing a JAX implementation for the approximate fitting routine
- Providing test data and commenting on expected output
- Yohsuke T. Fukai (@yfukai)
- Theoretical calculation for the optimization problem
- Implementation of the main fitting routine
- Providing tests
- Code review

### Old version (`f3fcf19`), used as the reference implementation to check the approximate algorithm
- Lorenz Lamm (@LorenzLamm)
- Mohammad Mirkazemi (@Mirkazemi)
Loading