Skip to content

Commit

Permalink
setup project and build files
Browse files Browse the repository at this point in the history
  • Loading branch information
gatling-nrl committed Jan 30, 2023
1 parent 9339e14 commit 0606ec4
Show file tree
Hide file tree
Showing 10 changed files with 71 additions and 1 deletion.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Distribution files
dist/
*.egg-info/

# Python cached files
*.pyc
__pycache__/
Empty file added LICENSE
Empty file.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
"# scikit-eit"
# scikit-eit

A Python package for electrical impedance tomography.
9 changes: 9 additions & 0 deletions docs/gettingstarted.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
=================
Getting started
=================

Install the package with

.. code-block:: bash
pip install scikit-eit
25 changes: 25 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
=============================
Documentation of scikit-eit
=============================

`scikit-eit <https://github.com/USNavalResearchLaboratory/scikit-eit>`_ is a pure
Python 3.7+ library for performing `electrical impedance tomography
<https://en.wikipedia.org/wiki/Electrical_impedance_tomography>`_.

.. note::

Installing the library with

.. code-block:: bash
python -m pip install scikit-eit
Table of contents
=================

.. toctree::

self
gettingstarted
api reference
File renamed without changes.
5 changes: 5 additions & 0 deletions docs/reference.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
==========================
API reference
==========================

This section contains API documentation for the most commonly used interfaces of the library.
22 changes: 22 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "scikit-eit"
version = "0.0.1"
authors = [
{ name="George Gatling", email="[email protected]" },
]
description = "A Python package for electrical impedance tomography."
readme = "README.md"
requires-python = ">=3.7"
classifiers = [
"Programming Language :: Python :: 3",
# "License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
]

[project.urls]
"Homepage" = "https://github.com/USNavalResearchLaboratory/scikit-eit"
"Bug Tracker" = "https://github.com/USNavalResearchLaboratory/scikit-eit/issues"
Empty file added skeit/__init__.py
Empty file.
File renamed without changes.

0 comments on commit 0606ec4

Please sign in to comment.