Initial commit

Author: dmey

.gitattributes

@@ -0,0 +1,2 @@
+# https://stackoverflow.com/a/58004619
+*.ipynb filter=strip-notebook-output

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    
+    - uses: goanpeca/setup-miniconda@v1
+      with:
+        activate-environment: synthia-test
+        environment-file: environment-test.yml
+
+    # Install all dev dependencies to build notebooks etc.
+    - uses: goanpeca/setup-miniconda@v1
+      with:
+        activate-environment: synthia
+        environment-file: environment.yml
+
+    - name: Install Synthia (dev env)
+      # 'shell' required to activate environment.
+      # See https://github.com/goanpeca/setup-miniconda#important.
+      shell: bash -l {0}
+      run: pip install .
+
+    - name: Build docs
+      shell: bash -l {0}
+      run: sphinx-build -v -b html docs/ docs/_build/fcQP3CXVFuXRU8pz
+
+    - name: Publish docs
+      if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_build

.gitignore

@@ -1,3 +1,6 @@
+# This project
+.vscode/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing
+
+TODO

DEVELOP.md

@@ -0,0 +1,41 @@
+# Development notes
+
+This are temporary development notes until we have a stable version on PyPI.
+
+
+## Conda environment (optional)
+
+Only required if you wish to install all the required prerequisites in [Miniconda](https://docs.conda.io/en/latest/miniconda.html)/[Anaconda](https://www.anaconda.com/) for local development and testing
+
+```
+conda env create -f environment.yml
+```
+
+Then activate with `conda activate synthia`.
+
+
+## Install synthia
+
+During development:
+
+```
+pip install -e .
+```
+
+
+## Documentation
+
+```
+sphinx-build -v -b html docs/ docs/_build/
+```
+
+Use `SKIP_NB=1` to skip building the example notebooks (they take a while to build):
+```
+SKIP_NB=1 sphinx-build -v -b html docs/ docs/_build/
+```
+
+## Docstrings
+
+Use [Google Style Python Docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html#google-vs-numpy).
+
+Note that type hints are intentionally not rendered as some of them become too complex and are better described in prose, following xarray's style.

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 D. Meyer, T. Nagler, M. Riechert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,32 @@
+<div align="center">
+  <img src="assets/img/logo.png" alt="synthia" height="120"><br><br>
+
+
+  [Overview](#overview) | [Documentation](#documentation) | [How to cite](#how-to-cite) | [Contributing](#contributing) | [Development notes](#development-notes) | [Copyright and license](#copyright-and-license)
+</div>
+
+## Overview
+
+Synthia is tool for generating (continuous) synthetic data for regression problems in Machine Learning (ML).
+[TODO]
+
+
+## Documentation
+
+For installation instructions, tutorials and general information, see https://dmey.github.io/synthia.
+
+## How to cite
+
+[TODO]
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Development notes
+
+See [DEVELOP.md](DEVELOP.md).
+
+## Copyright and license
+
+Copyright 2020 D. Meyer, T. Nagler, M. Riechert. Licensed under [MIT](LICENSE.txt).

assets/img/logo.png

@@ -0,0 +1,8 @@
+# We create this from LICENSE.txt at root.
+contributing.md
+develop.md
+license.md
+overview.md
+
+_build/
+data/