Release/0.1.0

.github/workflows/main.yml

@@ -0,0 +1,61 @@
+name: Run pytest
+on:
+  # Triggers the workflow on push or pull request events but only for the "develop" and "main" branch
+  push:
+    branches: [ "develop" , "main"]
+  pull_request:
+    branches: [ "develop" , "main"]
+
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout repository
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      # Setup Python
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      # install package	  
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python setup.py install
+
+      # install pytest
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest
+
+      # pytest -> JUnit xml
+      - name: PyTest
+        run: |
+          python -m pytest tests/unittests --junit-xml results/pytest.xml
+        continue-on-error: true
+
+      # show the results
+      - name: Upload Unit Test Results
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: Unit Test Results (Python 3.10)
+          path: results/*.xml
+
+      - name: Download Artifacts
+        if: success() || failure()
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+
+#      - name: Publish Unit Test Results
+#        uses: EnricoMi/publish-unit-test-result-action@v2
+#        with:
+#          files: artifacts/**/*.xml
+

.gitignore

@@ -0,0 +1,6 @@
+build/
+dist/
+dust/
+*.ipynb_checkpoints/
+*.egg-info/
+__pycache__

MANIFEST.in

@@ -0,0 +1,16 @@
+include src/jkepler/data/tests/v723mon_s12_rv.csv
+include src/jkepler/data/tests/mann19_astrometry.txt  
+include src/jkepler/data/tests/mann19_orbit.txt
+include src/jkepler/data/tests/kic11773022_koiinfo.csv	
+include src/jkepler/data/tests/kic11773022_long_transits.csv
+
+graft tests
+graft examples
+graft docs
+
+global-exclude *.py[co]
+
+prune documents/_build
+prune documents/_static
+prune documents/_templates
+prune documents/_build/doctrees/index.doctree

documents/Makefile

@@ -0,0 +1,20 @@
+# Minimal 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
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# 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)

documents/conf.py

@@ -0,0 +1,61 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import sphinx_rtd_theme
+import os
+import sys
+sys.path.insert(0, os.path.abspath('~/jkepler'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'jkepler'
+copyright = 'jkepler'
+author = 'Kento Masuda'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinxemoji.sphinxemoji',
+              ]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+html_logo = '_static/logo.png'
+
+#html_theme_options = {
+#    'style_nav_header_background': '#333',
+#}
+html_css_files = ['header.css']

documents/index.rst

@@ -0,0 +1,17 @@
+.. jkepler documentation master file, created by
+   sphinx-quickstart on Mon Jan 11 14:38:51 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+jkepler
+==================================
+
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API:
+
+   jkepler/jkepler.rst
+
+