Skip to content

Commit

Permalink
Renamed the project to ndoptimize. (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
byrdie authored Oct 28, 2024
1 parent 0c82d6d commit 5df944f
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/black.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ jobs:
- uses: psf/black@stable
with:
options: "--check --verbose --diff"
src: "./optimize"
src: "./ndoptimize"
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# optimize
# ndoptimize

[![Black](https://github.com/sun-data/optimize/actions/workflows/black.yml/badge.svg)](https://github.com/sun-data/optimize/actions/workflows/black.yml)
[![Ruff](https://github.com/sun-data/optimize/actions/workflows/ruff.yml/badge.svg)](https://github.com/sun-data/optimize/actions/workflows/ruff.yml)
[![Documentation Status](https://readthedocs.org/projects/optimize/badge/?version=latest)](https://sun-data-optimize.readthedocs.io/en/latest/?badge=latest)
[![Black](https://github.com/sun-data/ndoptimize/actions/workflows/black.yml/badge.svg)](https://github.com/sun-data/ndoptimize/actions/workflows/black.yml)
[![Ruff](https://github.com/sun-data/ndoptimize/actions/workflows/ruff.yml/badge.svg)](https://github.com/sun-data/ndoptimize/actions/workflows/ruff.yml)
[![Documentation Status](https://readthedocs.org/projects/ndoptimize/badge/?version=latest)](https://ndoptimize.readthedocs.io/en/latest/?badge=latest)

Numba-accelerated minimization of objective functions.
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

# -- Project information -----------------------------------------------------

project = 'optimize'
project = 'ndoptimize'
copyright = '2024, Roy T. Smart'
author = 'Roy T. Smart'

Expand Down Expand Up @@ -71,13 +71,13 @@
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/sun-data/optimize/",
"url": "https://github.com/sun-data/ndoptimize/",
"icon": "fa-brands fa-github",
"type": "fontawesome",
},
{
"name": "PyPI",
"url": "https://pypi.org/project/optimize/",
"url": "https://pypi.org/project/ndoptimize/",
"icon": "fa-brands fa-python",
},
],
Expand Down
9 changes: 4 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
Introduction
============

:mod:`optimize` is a experimental library designed to parallelize and
:mod:`ndoptimize` is an experimental library designed to parallelize and
accelerate objective function minimization, similar to the :mod:`scipy.optimize`
package, using the `Numba <https://numba.readthedocs.io/en/stable/>`_
just-in-time compiler.


Installation
============
:mod:`optimize` is published on PyPI and can be installed using::
:mod:`ndoptimize` is published on PyPI and can be installed using::

pip install optimize
pip install ndoptimize


API Reference
Expand All @@ -24,8 +24,7 @@ An in-depth description of the interfaces defined by this package.
:template: module_custom.rst
:recursive:

optimize

ndoptimize


Indices and tables
Expand Down
File renamed without changes.
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"

[project]
name = "optimize"
name = "ndoptimize"
authors = [
{name = "Roy T. Smart", email = "roytsmart@gmail.com"},
]
Expand Down Expand Up @@ -37,10 +37,10 @@ doc = [
]

[project.urls]
Homepage = "https://github.com/sun-data/optimize"
Documentation = "https://sun-data-optimize.readthedocs.io/en/latest"
Homepage = "https://github.com/sun-data/ndoptimize"
Documentation = "https://ndoptimize.readthedocs.io/en/latest"

[tool.setuptools]
packages = ["optimize"]
packages = ["ndoptimize"]

[tool.setuptools_scm]

0 comments on commit 5df944f

Please sign in to comment.