Skip to content

Commit

Permalink
Merge pull request #6 from munechika-koyo/develop
Browse files Browse the repository at this point in the history
📝 Update doc-related
  • Loading branch information
munechika-koyo authored Nov 15, 2023
2 parents 42ce2f6 + cb3ae67 commit 101a4e1
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
[![PyPI](https://img.shields.io/pypi/v/cherab-inversion?label=PyPI&logo=PyPI)](https://pypi.org/project/cherab-inversion/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cherab-inversion?logo=Python)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10118753.svg)](https://doi.org/10.5281/zenodo.10118753)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10118752.svg)](https://doi.org/10.5281/zenodo.10118752)
[![GitHub](https://img.shields.io/github/license/munechika-koyo/cherab_inversion)](https://opensource.org/licenses/BSD-3-Clause)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/munechika-koyo/cherab_inversion/main.svg)](https://results.pre-commit.ci/latest/github/munechika-koyo/cherab_inversion/main)
[![Documentation Status](https://readthedocs.org/projects/cherab-inversion/badge/?version=latest)](https://cherab-inversion.readthedocs.io/en/latest/?badge=latest)
[![PyPI Publish](https://github.com/munechika-koyo/cherab_inversion/actions/workflows/python-publish.yml/badge.svg)](https://github.com/munechika-koyo/cherab_inversion/actions/workflows/python-publish.yml)
[![PyPI Publish](https://github.com/munechika-koyo/cherab_inversion/actions/workflows/deploy-pypi.yml/badge.svg)](https://github.com/munechika-koyo/cherab_inversion/actions/workflows/deploy-pypi.yml)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
Expand Down
2 changes: 1 addition & 1 deletion cherab/inversion/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
from .mfr import Mfr

__all__ = ["compute_svd", "_SVDBase", "Lcurve", "GCV", "Mfr"]
__version__ = "0.1"
__version__ = "0.1.1"
5 changes: 2 additions & 3 deletions cherab/inversion/mfr.py
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ def solve(
regularizer: Type["_SVDBase"] = Lcurve,
store_regularizers: bool = False,
path: str | Path | None = None,
use_gpu: bool = True,
use_gpu: bool = False,
verbose: bool = False,
**kwargs,
) -> tuple[np.ndarray, dict]:
Expand Down Expand Up @@ -184,8 +184,7 @@ def solve(
If `path` is None, the regularizer objects will be stored in the current directory
if `store_regularizers` is True.
use_gpu
same as :obj:`~.compute_svd`'s `use_gpu` argument,
by default True
same as :obj:`~.compute_svd`'s `use_gpu` argument, by default False
verbose
If True, print iteration information regarding SVD computation, by default False
**kwargs
Expand Down
2 changes: 1 addition & 1 deletion docs/source/_static/switcher.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
},
{
"name": "0.1",
"version": "v0.1",
"version": "v0.1.1",
"url": "https://cherab-inversion.readthedocs.io/en/v0.1/",
"preferred": true
}
Expand Down
11 changes: 6 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,11 +112,7 @@
# If it is an integer, we're in a PR build and the version isn't correct.
# If it's "latest" → change to "dev" (that's what we want the switcher to call it)
if not version_match or version_match.isdigit() or version_match == "latest":
# For local development, infer the version to match from the package.
if version_obj.is_prerelease:
version_match = "dev"
else:
version_match = f"v{release}"
version_match = "dev"
elif version_match == "stable":
version_match = f"v{release}"

Expand All @@ -128,6 +124,11 @@
"icon": "fab fa-github-square",
"type": "fontawesome",
},
{
"name": "PyPI",
"url": "https://pypi.org/project/cherab-inversion",
"icon": "fa-solid fa-box",
},
],
"pygment_light_style": "default",
"pygment_dark_style": "native",
Expand Down
4 changes: 2 additions & 2 deletions docs/source/user/citation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ Citations
=========
If you would like to publish or write paper using CHERAB-Inversion, please cite the following doi:

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10118753.svg
:target: https://doi.org/10.5281/zenodo.10118753
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10118752.svg
:target: https://doi.org/10.5281/zenodo.10118752
2 changes: 1 addition & 1 deletion meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ project(
'cherab-inversion',
'cython',
# Note that version cannot dinamically changed now.
version: '0.1',
version: '0.1.1',
meson_version: '>= 0.64.0',
default_options: [
'cython_args=-3',
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ build-backend = "mesonpy"
[project]
name = "cherab-inversion"
description = "Cherab inversion framework"
version = "0.1"
version = "0.1.1"
readme = "README.md"
authors = [
{ name = "Koyo Munechika", email = "munechika.koyo@torus.nr.titech.ac.jp" },
Expand Down

0 comments on commit 101a4e1

Please sign in to comment.