Commit 5612cdb0 authored by JOSSOUD Olivier's avatar JOSSOUD Olivier
Browse files

First commit.

parent 01dec452
Pipeline #56790 passed with stages
in 1 minute and 14 seconds
**.log
*cache*
wimcollect/config/settings.ini
# Sphinx processed files
docs/build
# Sphinx-apidoc files
docs/source/api
# Virtual environment
venv
# Generated files
.idea/**/contentModel.xml
# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml
\ No newline at end of file
image: python
pages:
script:
- apt-get update
- pip install -r wimcollect/requirements.txt
- sphinx-apidoc --module-first --force -o docs/source/api/ wimcollect/ wimcollect/tests/*
- cd docs/
- apt-get install -y make
- make html
- cd ../
- rm -rf public/
- mkdir public/
- cp -R docs/build/html/* public/
artifacts:
paths:
- public
only:
- master
\ No newline at end of file
# Default ignored files
/workspace.xml
\ No newline at end of file
<component name="InspectionProjectProfileManager">
<settings>
<option name="USE_PROJECT_PROFILE" value="false" />
<version value="1.0" />
</settings>
</component>
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectRootManager" version="2" project-jdk-name="Python 3.7 (wimcollect)" project-jdk-type="Python SDK" />
</project>
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/wimcollect.iml" filepath="$PROJECT_DIR$/.idea/wimcollect.iml" />
</modules>
</component>
</project>
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
</project>
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<module type="PYTHON_MODULE" version="4">
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$">
<excludeFolder url="file://$MODULE_DIR$/venv" />
</content>
<orderEntry type="jdk" jdkName="Python 3.7 (wimcollect)" jdkType="Python SDK" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
<component name="PackageRequirementsSettings">
<option name="requirementsPath" value="$MODULE_DIR$/wimcollect/requirements_pkg.txt" />
</component>
<component name="PyDocumentationSettings">
<option name="format" value="NUMPY" />
<option name="myDocStringFormat" value="NumPy" />
</component>
</module>
\ No newline at end of file
include config/settings_default.json
\ No newline at end of file
# 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 = source
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)
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
.wy-nav-content {
max-width: 1200px !important;
}
\ No newline at end of file
# 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:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- 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 os
import sys
# sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../..'))
sys.path.insert(0, os.path.abspath('../../wimcollect/'))
# -- Project information -----------------------------------------------------
project = 'WIM Collect'
copyright = '2020, Olivier Jossoud'
author = 'Olivier Jossoud'
# The full version, including alpha/beta/rc tags
release = '0.1'
# -- 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.autosummary',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'numpydoc'
]
# 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 = []
# -- 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']
# Path to custom CSS to modify theme.
html_css_files = [
'css/custom.css',
]
\ No newline at end of file
Welcome to WIM Collect's documentation
==================================================
.. toctree::
:maxdepth: 3
:caption: Modules:
api/modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
# Automatically generate wimcollect' API documentation using sphinx-apidoc.
# --force --> files will be overriden if they already exist
# -o docs/source/api/ --> Output's .rst files location
# wimcollect/ --> Autodoc all packages from wimcollect/
# wimcollect/tests/* --> Exclude tests/ package.
sphinx-apidoc --module-first --force -o docs/source/api/ wimcollect/ wimcollect/tests/*
\ No newline at end of file
from setuptools import setup, find_packages
with open("README.md", 'r') as f:
long_description = f.read()
with open('wimcollect/requirements_pkg.txt') as f:
requirements = f.read().splitlines()
setup(
name='wimcollect',
version='0.1',
description='',
license="CeCILL",
long_description=long_description,
author='Olivier Jossoud',
author_email='olivier.jossoud@lsce.ipsl.fr',
url="https://gitlab.in2p3.fr/olivier.jossoud/wimcollect",
packages=find_packages(where='.', exclude=["*.tests", "*.tests.*", "tests.*", "tests"]),
entry_points={ # Optional
'console_scripts': [
'wimcollect=wimcollect.main:main',
],
},
package_data={ # Optional
'wimcollect': ['config/settings_default.ini'],
},
install_requires=requirements,
include_package_data=True
)
[SITE]
# Site's trigram (e.g. REU, AMS, SRT, etc.)
site_id = REU
[GLOBAL]
# Absolute path of the local directory where the to-be-sent compressed files will temporarily be stored.
to_send_dir = C:\wimcollect\toSend\
[PICARRO]
# Picarro's unique identifier (e.g. HIDS2179, HIDS2108, etc.)
picarro_id = HIDS2179
# Absolute path of the local directory containing the Picarro's `.dat` data file. This is the directory containing one
# folder per year. It is very probably named `DataLog_User`.
base_dir = C:\UserData\DataLog_User\
# Date (in ISO format: yyyy-mm-dd) of the last successful compression of Picarro data. This parameters is automatically
# updated by the software. The user may only modify it at initialization or for debug purposes.
last_compression = 2020-01-06
[HOBO]
# ";"-separated list of Hobo instrument's reference.
hobo_ids = 10467007;10467009
# Absolute path of the local directory containing the Hobo's `.csv` data file.
base_dir = C:\Users\picarro\Documents\HOBOware\
# Date (in ISO format: yyyy-mm-dd) of the last successful compression of Hobo data. This parameters is automatically
# updated by the software. The user may only modify it at initialization or for debug purposes.
last_compression = 2019-12-17
[FTP]
# Address of the FTP server (without ftp://)
host = ftp.cea.fr
# FTP user
user = XXXX
# FTP Password
password = YYYYY
# Absolute path of the distant FTP directory where the compressed files should be uploaded. Note that subdirectories
# related to the site and instrument will automatically added.
root_dir = /pub/ramces/data/
[LOGGER]
# Log files older than `keep_log_day` will be automatically deleted.
keep_log_days = 5
# Absolute path to the directory where the log files are stored.
log_dir = C:\wimcollect\log\
-r requirements_dev.txt
-r requirements_pkg.txt
sphinx==2.2.*
sphinx_rtd_theme==0.4.*
numpydoc==0.9.*
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment