diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index e1d2005..efe1b07 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -1 +1,44 @@ -name: tests on: push: branches: [main] pull_request: branches: [main] jobs: build: runs-on: ubuntu-latest strategy: matrix: python-version: ["3.7", "3.8", "3.9", "3.10"] steps: - uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -m pip install --upgrade pip pip install flake8 pytest pytest-cov pip --default-timeout=100 install -e . pip --default-timeout=100 install "tensorflow>=2.0.0" - name: Lint with flake8 run: | # stop the build if there are Python syntax errors or undefined names flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics - name: Test with pytest run: | pytest --doctest-modules --cov=ewstools --cov-report=xml tests/ - name: Upload coverage to Codecov uses: codecov/codecov-action@v3 with: files: ./coverage.xml verbose: true # optional (default = false) \ No newline at end of file +name: tests + +on: + push: + branches: [main] + pull_request: + branches: [main] + + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.7", "3.8", "3.9", "3.10"] + + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install flake8 pytest pytest-cov + pip --default-timeout=100 install -e . + pip --default-timeout=100 install "keras<3.0.0" + pip --default-timeout=100 install "tensorflow>=2.0.0,<2.12" + - name: Lint with flake8 + run: | + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Test with pytest + run: | + pytest --doctest-modules --cov=ewstools --cov-report=xml tests/ + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v3 + with: + files: ./coverage.xml + verbose: true # optional (default = false) \ No newline at end of file diff --git a/README.md b/README.md index ae8bbac..ae1dae1 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ Package dependencies are 'statsmodels>=0.9.0', 'scipy>=1.0.1', ``` -and should be installed automatically. To use any of the deep learning functionality, you will need to install [TensorFlow](https://www.tensorflow.org/install) v2.0.0 or later. +and should be installed automatically. To use the deep learning functionality, you will need to install [TensorFlow](https://www.tensorflow.org/install) v2.0.0 or later with [Keras](https://keras.io/2.16/api/) v2. To install the latest *development* version, use the command ```bash diff --git a/docs/source/ewstools.rst b/docs/source/ewstools.rst index 181bdfd..7c2911b 100644 --- a/docs/source/ewstools.rst +++ b/docs/source/ewstools.rst @@ -1,4 +1,4 @@ -ewstools package +API ================