Merge pull request #1 from DeltaE/initial-setup

Initial setup

.coveragerc

@@ -0,0 +1,28 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+source = delta_e
+# omit = bad_file.py
+
+[paths]
+source =
+    src/
+    */site-packages/
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:

.gitignore

@@ -0,0 +1,54 @@
+# Temporary and binary files
+*~
+*.py[cod]
+*.so
+*.cfg
+!.isort.cfg
+!setup.cfg
+*.orig
+*.log
+*.pot
+__pycache__/*
+.cache/*
+.*.swp
+*/.ipynb_checkpoints/*
+.DS_Store
+
+# Project files
+.ropeproject
+.project
+.pydevproject
+.settings
+.idea
+.vscode
+tags
+
+# Package files
+*.egg
+*.eggs/
+.installed.cfg
+*.egg-info
+
+# Unittest and coverage
+htmlcov/*
+.coverage
+.coverage.*
+.tox
+junit*.xml
+coverage.xml
+.pytest_cache/
+
+# Build and docs folder/files
+build/*
+dist/*
+sdist/*
+docs/api/*
+docs/_rst/*
+docs/_build/*
+cover/*
+MANIFEST
+
+# Per-project virtualenvs
+.venv*/
+.conda*/
+.python-version

.readthedocs.yml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+python:
+  version: 3.8
+  install:
+    - requirements: docs/requirements.txt
+    - {path: ., method: pip}

LICENSE → LICENSE.md

@@ -1,4 +1,4 @@
-MIT License
+The MIT License (MIT)
 
 Copyright (c) 2022 DeltaE
 

README.md

@@ -1,8 +1,44 @@
-# graphic-scripts
-This repo hosts all Delta-E members visualization code and scripts.
+<!--  
+% These are examples of badges you might want to add to your README:
+% please update the URLs accordingly
+%
+%  .. image:: https://api.cirrus-ci.com/github/<USER>/delta-e.svg?branch=main
+%      :alt: Built Status
+%      :target: https://cirrus-ci.com/github/<USER>/delta-e
+%  .. image:: https://readthedocs.org/projects/delta-e/badge/?version=latest
+%      :alt: ReadTheDocs
+%      :target: https://delta-e.readthedocs.io/en/stable/
+%  .. image:: https://img.shields.io/coveralls/github/<USER>/delta-e/main.svg
+%      :alt: Coveralls
+%      :target: https://coveralls.io/r/<USER>/delta-e
+%  .. image:: https://img.shields.io/pypi/v/delta-e.svg
+%      :alt: PyPI-Server
+%      :target: https://pypi.org/project/delta-e/
+%  .. image:: https://img.shields.io/conda/vn/conda-forge/delta-e.svg
+%      :alt: Conda-Forge
+%      :target: https://anaconda.org/conda-forge/delta-e
+%  .. image:: https://pepy.tech/badge/delta-e/month
+%      :alt: Monthly Downloads
+%      :target: https://pepy.tech/project/delta-e
+%  .. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter
+%      :alt: Twitter
+%      :target: https://twitter.com/delta-e 
+-->
 
-Please create a new folder for your contributed code/scripts which produce visualizations. This folder should contain the following items:
+![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)
 
-  - Code/script to produce visual.
-  - An image file (.png, .jpg) of the visual(s) which the script(s) create.
-  - Data files involved in the visualization. Alternatively, a document indicating how to access the needed data to reproduce the visuals.
+# delta-e utility functions 
+
+Description of repository 
+
+## Contents 
+
+- [Contributing](https://github.com/DeltaE)
+- [API Reference](https://github.com/DeltaE)
+- [Datasets](https://github.com/DeltaE)
+- [Authors](https://github.com/DeltaE)
+
+## Note
+
+This project has been set up using PyScaffold 4.3. For details and usage
+information on PyScaffold see <https://pyscaffold.org/>.

docs/Makefile

@@ -0,0 +1,29 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+AUTODOCDIR    = api
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $?), 1)
+$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://sphinx-doc.org/")
+endif
+
+.PHONY: help clean Makefile
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	rm -rf $(BUILDDIR)/* $(AUTODOCDIR)
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/.gitignore

@@ -0,0 +1 @@
+# Empty directory

docs/authors.md

@@ -0,0 +1,12 @@
+# Contributors
+
+- [Elias Islam](https://github.com/eliasinul)
+- [Kamaria Kuling](https://github.com/kkuling)
+- [Narges Sefid](https://github.com/DeltaE)
+- [Nastaran Arianpoo](https://github.com/Nastaran-sfu)
+- [Pierre McWhannel](https://github.com/pmcwhannel)
+- [Sina Motalebi](https://github.com/Sfusina)
+- [Taco Niet](https://github.com/tniet)
+- [Tewodros Walle Mekonnen](https://github.com/DeltaE)
+- [Trevor Barnes](https://github.com/trevorb1)
+- [Yalda Saedi](https://github.com/YSaedi)

docs/changelog.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## Version 0.1
+
+- Inital commit 
+- Initial documentation