change project name from pysol to inductance since PyPI didn't have p…

…ysol available

.cookiecutter.json

@@ -5,10 +5,10 @@
   "copyright_year": "2023",
   "development_status": "Development Status :: 4 - Beta",
   "email": "[email protected]",
-  "friendly_name": "PySol",
+  "friendly_name": "Inductance",
   "github_user": "dgarnier",
   "license": "MIT",
-  "package_name": "pysol",
-  "project_name": "pysol",
+  "package_name": "inductance",
+  "project_name": "inductance",
   "version": "0.1.0"
 }

.flake8

@@ -6,4 +6,4 @@ max-complexity = 10
 docstring-convention = google
 rst-roles = class,const,func,meth,mod,ref
 rst-directives = deprecated
-exclude = src/pysol/elliptics.py
+exclude = src/inductance/elliptics.py

.gitignore

@@ -8,5 +8,5 @@
 /docs/_build/
 /src/*.egg-info/
 __pycache__/
-src/pysol/_version.py
+src/inductance/_version.py
 tests/test_new_dipole.py

CONTRIBUTING.md

@@ -12,9 +12,9 @@ Here is a list of important resources for contributors:
 - [Code of Conduct]
 
 [mit license]: https://opensource.org/licenses/MIT
-[source code]: https://github.com/dgarnier/pysol
-[documentation]: https://pysol.readthedocs.io/
-[issue tracker]: https://github.com/dgarnier/pysol/issues
+[source code]: https://github.com/dgarnier/inductance
+[documentation]: https://inductance.readthedocs.io/
+[issue tracker]: https://github.com/dgarnier/inductance/issues
 
 ## How to report a bug
 
@@ -54,7 +54,6 @@ or the command-line interface:
 
 ```console
 $ poetry run python
-$ poetry run pysol
 ```
 
 [poetry]: https://python-poetry.org/
@@ -108,7 +107,7 @@ $ nox --session=pre-commit -- install
 It is recommended to open an issue before starting work on anything.
 This will allow a chance to talk it over with the owners and validate your approach.
 
-[pull request]: https://github.com/dgarnier/pysol/pulls
+[pull request]: https://github.com/dgarnier/inductance/pulls
 
 <!-- github-only -->
 

README.md

@@ -1,21 +1,21 @@
-# PySol
+# Inductance
 
-[![PyPI](https://img.shields.io/pypi/v/pysol.svg)][pypi status]
-[![Status](https://img.shields.io/pypi/status/pysol.svg)][pypi status]
-[![Python Version](https://img.shields.io/pypi/pyversions/pysol)][pypi status]
-[![License](https://img.shields.io/pypi/l/pysol)][license]
+[![PyPI](https://img.shields.io/pypi/v/inductance.svg)][pypi status]
+[![Status](https://img.shields.io/pypi/status/inductance.svg)][pypi status]
+[![Python Version](https://img.shields.io/pypi/pyversions/inductance)][pypi status]
+[![License](https://img.shields.io/pypi/l/inductance)][license]
 
-[![Read the documentation at https://pysol.readthedocs.io/](https://img.shields.io/readthedocs/pysol/latest.svg?label=Read%20the%20Docs)][read the docs]
-[![Tests](https://github.com/dgarnier/pysol/workflows/Tests/badge.svg)][tests]
-[![Codecov](https://codecov.io/gh/dgarnier/pysol/branch/main/graph/badge.svg)][codecov]
+[![Read the documentation at https://inductance.readthedocs.io/](https://img.shields.io/readthedocs/inductance/latest.svg?label=Read%20the%20Docs)][read the docs]
+[![Tests](https://github.com/dgarnier/inductance/workflows/Tests/badge.svg)][tests]
+[![Codecov](https://codecov.io/gh/dgarnier/inductance/branch/main/graph/badge.svg)][codecov]
 
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
 [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
 
-[pypi status]: https://pypi.org/project/pysol/
-[read the docs]: https://pysol.readthedocs.io/
-[tests]: https://github.com/dgarnier/pysol/actions?workflow=Tests
-[codecov]: https://app.codecov.io/gh/dgarnier/pysol
+[pypi status]: https://pypi.org/project/inductance/
+[read the docs]: https://inductance.readthedocs.io/
+[tests]: https://github.com/dgarnier/inductance/actions?workflow=Tests
+[codecov]: https://app.codecov.io/gh/dgarnier/inductance
 [pre-commit]: https://github.com/pre-commit/pre-commit
 [black]: https://github.com/psf/black
 
@@ -29,10 +29,10 @@
 
 ## Installation
 
-You can install _PySol_ via [pip] from [PyPI]:
+You can install _inductance_ via [pip] from [PyPI]:
 
 ```console
-$ pip install pysol
+$ pip install inductance
 ```
 
 ## Usage
@@ -47,7 +47,7 @@ To learn more, see the [Contributor Guide].
 ## License
 
 Distributed under the terms of the [MIT license][license],
-_PySol_ is free and open source software.
+_inductance_ is free and open source software.
 
 ## Issues
 
@@ -61,11 +61,11 @@ This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter]
 [@cjolowicz]: https://github.com/cjolowicz
 [pypi]: https://pypi.org/
 [hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
-[file an issue]: https://github.com/dgarnier/pysol/issues
+[file an issue]: https://github.com/dgarnier/inductance/issues
 [pip]: https://pip.pypa.io/
 
 <!-- github-only -->
 
-[license]: https://github.com/dgarnier/pysol/blob/main/LICENSE
-[contributor guide]: https://github.com/dgarnier/pysol/blob/main/CONTRIBUTING.md
-[command-line reference]: https://pysol.readthedocs.io/en/latest/usage.html
+[license]: https://github.com/dgarnier/inductance/blob/main/LICENSE
+[contributor guide]: https://github.com/dgarnier/inductance/blob/main/CONTRIBUTING.md
+[command-line reference]: https://inductance.readthedocs.io/en/latest/usage.html

docs/conf.py

@@ -1,5 +1,5 @@
 """Sphinx configuration."""
-project = "PySol"
+project = "Inductance"
 author = "Darren Garnier"
 copyright = "2023, Darren Garnier"
 extensions = [

docs/index.md

@@ -19,5 +19,5 @@ reference
 contributing
 Code of Conduct <codeofconduct>
 License <license>
-Changelog <https://github.com/dgarnier/pysol/releases>
+Changelog <https://github.com/dgarnier/inductance/releases>
 ```

docs/reference.md

@@ -1,8 +1,8 @@
 # Reference
 
-## pysol
+## inductance
 
 ```{eval-rst}
-.. automodule:: pysol
+.. automodule:: inductance
    :members:
 ```

noxfile.py

@@ -20,7 +20,7 @@
     raise SystemExit(dedent(message)) from None
 
 
-package = "pysol"
+package = "inductance"
 python_versions = ["3.10", "3.9", "3.8"]
 nox.needs_version = ">= 2021.6.6"
 nox.options.sessions = (

pyproject.toml

@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "pysol"
+name = "inductance"
 # version set in git tag
 version = "0.0.0"
 description = "Code for 2D magnetostatics (aka Solenoids)"

src/pysol/__init__.py → src/inductance/__init__.py

@@ -1,4 +1,4 @@
-"""PySol."""
+"""Inductance."""
 
 # this gets replaced with the package version during the build process
 __version__ = "0.0.0"

src/pysol/__main__.py → src/inductance/__main__.py

@@ -5,8 +5,8 @@
 @click.command()
 @click.version_option()
 def main() -> None:
-    """PySol."""
+    """Inductance."""
 
 
 if __name__ == "__main__":
-    main(prog_name="pysol")  # pragma: no cover
+    main(prog_name="inductance")  # pragma: no cover

tests/__init__.py

@@ -1 +1 @@
-"""Test suite for the pysol package."""
+"""Test suite for the inductance package."""

tests/test_elliptics.py

@@ -1,8 +1,7 @@
 """Test the elliptics module."""
 
 import unittest
-
-from pysol.elliptics import ellipke
+from inductance.elliptics import ellipke
 
 
 class TestElliptics(unittest.TestCase):

tests/test_ldx.py

@@ -1,10 +1,8 @@
 """Test filamentation and inducatance of LDX coils."""
 
 import unittest
-
 import numpy as np
-
-from pysol.filaments import (
+from inductance.filaments import (
     FilamentCoil,
     Lfil,
     LLyle4,

tests/test_main.py

@@ -1,8 +1,7 @@
 """Test cases for the __main__ module."""
 import pytest
 from click.testing import CliRunner
-
-from pysol import __main__
+from inductance import __main__
 
 
 @pytest.fixture