Skip to content

Commit

Permalink
Rename opensourceeconomics -> optimagic-dev; adjust badges
Browse files Browse the repository at this point in the history
  • Loading branch information
timmens committed Aug 25, 2024
1 parent 95891f5 commit 82ef58a
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 32 deletions.
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is a record of all past optimagic releases and what went into them in reverse
chronological order. We follow [semantic versioning](https://semver.org/) and all
releases are available on [Anaconda.org](https://anaconda.org/OpenSourceEconomics/optimagic).
releases are available on [Anaconda.org](https://anaconda.org/optimagic-dev/optimagic).

Following the [scientific python guidelines](https://scientific-python.org/specs/spec-0000/)
we drop the official support for Python 3.9.
Expand Down
6 changes: 3 additions & 3 deletions CITATION
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@

Please use one of the following samples to cite the estimagic version (change
Please use one of the following samples to cite the optimagic version (change
x.y) from this installation

Text:

[optimagic] optimagic x.y, 2024
Janos Gabler, https://github.com/OpenSourceEconomics/optimagic
Janos Gabler, https://github.com/optimagic-dev/optimagic

BibTeX:

@Unpublished{Gabler2024,
Title = {optimagic: A library for nonlinear optimization},
Author = {Janos Gabler},
Year = {2024},
Url = {https://github.com/OpenSourceEconomics/optimagic}
Url = {https://github.com/optimagic-dev/optimagic}
}

If you are unsure about which version of optimagic you are using run: `conda list optimagic`.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# optimagic

![PyPI - Version](https://img.shields.io/pypi/v/optimagic)
[![image](https://img.shields.io/pypi/pyversions/estimagic)](https://pypi.org/project/estimagic)
[![image](https://img.shields.io/conda/vn/conda-forge/estimagic.svg)](https://anaconda.org/conda-forge/estimagic)
[![image](https://img.shields.io/conda/pn/conda-forge/estimagic.svg)](https://anaconda.org/conda-forge/estimagic)
[![image](https://img.shields.io/pypi/l/estimagic)](https://pypi.org/project/estimagic)
[![image](https://readthedocs.org/projects/estimagic/badge/?version=latest)](https://estimagic.readthedocs.io/en/latest)
[![image](https://img.shields.io/github/actions/workflow/status/OpenSourceEconomics/estimagic/main.yml?branch=main)](https://github.com/OpenSourceEconomics/estimagic/actions?query=branch%3Amain)
[![image](https://codecov.io/gh/OpenSourceEconomics/estimagic/branch/main/graph/badge.svg)](https://codecov.io/gh/OpenSourceEconomics/optimagic)
[![image](https://results.pre-commit.ci/badge/github/OpenSourceEconomics/estimagic/main.svg)](https://github.com/OpenSourceEconomics/optimagic/actions?query=branch%3Amain)
[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![image](https://img.shields.io/pypi/pyversions/optimagic)](https://pypi.org/project/optimagic)
[![image](https://img.shields.io/conda/vn/conda-forge/optimagic.svg)](https://anaconda.org/conda-forge/optimagic)
[![image](https://img.shields.io/conda/pn/conda-forge/optimagic.svg)](https://anaconda.org/conda-forge/optimagic)
[![image](https://img.shields.io/pypi/l/optimagic)](https://pypi.org/project/optimagic)
[![image](https://readthedocs.org/projects/optimagic/badge/?version=latest)](https://optimagic.readthedocs.io/en/latest)
[![image](https://img.shields.io/github/actions/workflow/status/optimagic-dev/optimagic/main.yml?branch=main)](https://github.com/optimagic-dev/optimagic/actions?query=branch%3Amain)
[![image](https://codecov.io/gh/optimagic-dev/optimagic/branch/main/graph/badge.svg)](https://codecov.io/gh/optimagic-dev/optimagic)
[![image](https://results.pre-commit.ci/badge/github/optimagic-dev/optimagic/main.svg)](https://github.com/optimagic-dev/optimagic/actions?query=branch%3Amain)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![image](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
[![image](https://pepy.tech/badge/estimagic/month)](https://pepy.tech/project/estimagic)
[![image](https://pepy.tech/badge/optimagic/month)](https://pepy.tech/project/optimagic)
[![image](https://img.shields.io/badge/NumFOCUS-affiliated%20project-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org/sponsored-projects/affiliated-projects)
[![image](https://img.shields.io/twitter/follow/aiidateam.svg?style=social&label=Follow)](https://x.com/optimagic)

Expand Down Expand Up @@ -86,7 +86,7 @@ If you use optimagic for your research, please do not forget to cite it.
Title = {optimagic: A library for nonlinear optimization},
Author = {Janos Gabler},
Year = {2022},
Url = {https://github.com/OpenSourceEconomics/optimagic}
Url = {https://github.com/optimagic-dev/optimagic}
}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@

extlinks = {
"ghuser": ("https://github.com/%s", "@"),
"gh": ("https://github.com/OpenSourceEconomics/optimagic/pulls/%s", "#"),
"gh": ("https://github.com/optimagic-dev/optimagic/pulls/%s", "#"),
}

intersphinx_mapping = {
Expand Down
4 changes: 2 additions & 2 deletions docs/source/development/ep-01-pytrees.md
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ three types of moments have to be aligned, i.e. be stored in a tree of the same
structure. We will raise an error if the trees do not have the same structure.

This is a generalization of an interface that has already proven useful in
[respy](https://github.com/OpenSourceEconomics/respy),
[respy](https://github.com/optimagic-dev/respy),
[sid](https://github.com/covid-19-impact-lab/sid) and other applications. In the future,
the project specific implementations of flatten and unflatten functions could simply be
deleted.
Expand Down Expand Up @@ -734,4 +734,4 @@ arrays and numbers for automatic differentiation.
If you want to use automatic differentiation with estimagic you will thus have to
restrict yourself in the way you specify parameters.

[pybaum]: https://github.com/OpenSourceEconomics/pybaum
[pybaum]: https://github.com/optimagic-dev/pybaum
12 changes: 6 additions & 6 deletions docs/source/development/how_to_contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ ideas and guide the development process from the beginning. You can start a conv
by posting an issue on GitHub or by emailing [janosg](https://github.com/janosg).

To get familiar with the codebase, we recommend checking out our
[issue tracker](https://github.com/OpenSourceEconomics/optimagic/issues) for some
immediate and clearly defined tasks.
[issue tracker](https://github.com/optimagic-dev/optimagic/issues) for some immediate
and clearly defined tasks.

## 2. Before you start

Expand All @@ -30,11 +30,11 @@ contribution process (see Notes below).

## 3. Step-by-step guide

1. Fork the [optimagic repository](https://github.com/OpenSourceEconomics/optimagic/).
This action creates a copy of the repository with write access for you.
1. Fork the [optimagic repository](https://github.com/optimagic-dev/optimagic/). This
action creates a copy of the repository with write access for you.

```{note}
For regular contributors: **Clone** the [repository](https://github.com/OpenSourceEconomics/optimagic/) to your local machine and create a new branch for implementing your changes. You can push your branch directly to the remote optimagic repository and open a PR from there.
For regular contributors: **Clone** the [repository](https://github.com/optimagic-dev/optimagic/) to your local machine and create a new branch for implementing your changes. You can push your branch directly to the remote optimagic repository and open a PR from there.
```

2. Clone your forked repository to your disk. This is where you'll make all your
Expand Down Expand Up @@ -110,7 +110,7 @@ Skip the next paragraph if you haven't worked on the documentation.
```

Follow the steps outlined in the optimagic
[PR template](https://github.com/OpenSourceEconomics/optimagic/blob/main/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md)
[PR template](https://github.com/optimagic-dev/optimagic/blob/main/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md)
to describe your contribution, the problem it addresses, and your proposed solution.

Opening a PR initiates a complete CI run, including the `pytest` suite, linters, code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
(to be written.)

In case of an urgent request for this guide, feel free to open an issue
\[here\](<https://github.com/OpenSourceEconomics/estimagic/issues>).
\[here\](<https://github.com/optimagic-dev/estimagic/issues>).
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ content-type = "text/markdown"
text = "MIT"

[project.urls]
Repository = "https://github.com/opensourceeconomics/optimagic"
Github = "https://github.com/opensourceeconomics/optimagic"
Tracker = "https://github.com/OpenSourceEconomics/optimagic/issues"
Repository = "https://github.com/optimagic-dev/optimagic"
Github = "https://github.com/optimagic-dev/optimagic"
Tracker = "https://github.com/optimagic-dev/optimagic/issues"


# ======================================================================================
Expand Down
6 changes: 3 additions & 3 deletions src/optimagic/optimization/create_optimization_problem.py
Original file line number Diff line number Diff line change
Expand Up @@ -282,23 +282,23 @@ def create_optimization_problem(
if hess is not None:
msg = (
"The hess argument is not yet supported in optimagic. Creat an issue on "
"https://github.com/OpenSourceEconomics/optimagic/ if you have urgent need "
"https://github.com/optimagic-dev/optimagic/ if you have urgent need "
"for this feature."
)
raise NotImplementedError(msg)

if hessp is not None:
msg = (
"The hessp argument is not yet supported in optimagic. Creat an issue on "
"https://github.com/OpenSourceEconomics/optimagic/ if you have urgent need "
"https://github.com/optimagic-dev/optimagic/ if you have urgent need "
"for this feature."
)
raise NotImplementedError(msg)

if callback is not None:
msg = (
"The callback argument is not yet supported in optimagic. Creat an issue "
"on https://github.com/OpenSourceEconomics/optimagic/ if you have urgent "
"on https://github.com/optimagic-dev/optimagic/ if you have urgent "
"need for this feature."
)
raise NotImplementedError(msg)
Expand Down
2 changes: 1 addition & 1 deletion src/optimagic/optimization/scipy_aliases.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def map_method_to_algorithm(method):
elif method in not_implemented:
msg = (
f"The method {method} is not yet wrapped in optimagic. Create an issue on "
"https://github.com/OpenSourceEconomics/optimagic/ if you have urgent need "
"https://github.com/optimagic-dev/optimagic/ if you have urgent need "
"for this method."
)
raise NotImplementedError(msg)
Expand Down

0 comments on commit 82ef58a

Please sign in to comment.