Merge pull request #131 from DeepRank/development

Development

Author: NicoRenaud

.gitignore

@@ -5,15 +5,32 @@ Byte-compiled / optimized
 deeprank.egg-info
 database*
 
+# specific architure files
+deeprank/learn/arch_*
+
 # some example file
 example/grid/ELEC
 example/grid/VDW
 example/grid/data_viz
 example/grid/input
 example/workflow/test_out
+example/hdf5
+example/out_3d
+example/*.pckl
+example/*.hdf5
+example/*.pdb
+
+# some test file
+test/out_2d*
+test/out_3d*
+test/out_test
+test/*.pckl
+test/*.hdf5
+test/*.pdb
+
 
 # datafile
-*.pdb
+#*.pdb
 *.CHARGE
 *.db
 *.COULOMB
@@ -27,5 +44,15 @@ example/workflow/test_out
 #docs/_static
 #docs/_templates
 
+
+# vscode setting
+.vscode
+
+.DS_Store
+test/1AK4/atomic_features/test_1AK4_100w.dat
+test/2OUL/atomic_features/test_2OUL_1.dat
+test/atomic_pair_interaction.dat
+
 # Mac OSX files
 .DS_Store
+

.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
-distr : "trusty"
+distr : "bionic"
 
 language: generic
 
@@ -16,44 +16,11 @@ before_install:
   # Useful for debugging any issues with conda
   - conda info -a
 
- # pytest
-  - conda install -c anaconda pytest
-  - conda install -c conda-forge pytest-cov
-  - conda install python=3.6
-
-  # install freesasa python bindings
-  # - pip install freesasa==2.0.3.post4 # <- doesn't work anymore
-
-  # install freesasa
-  # - conda install cython
-  # - git clone https://github.com/freesasa/freesasa-python
-  # - cd freesasa-python
-  # - git submodule update --init
-  # - USE_CYTHON=1 python setup.py build
-  # - export PYTHONPATH=$PYTHONPATH: ???
-
-  # install freesasa
-  - conda install cython
-  - sudo apt-get install -y libxml2 libxml2-dev libjson0 libjson0-dev
-  - wget http://github.com/mittinatten/freesasa/releases/download/2.0.2/freesasa-2.0.2.tar.gz
-  - mkdir freesasa
-  - tar -xvf freesasa-2.0.2.tar.gz -C freesasa --strip-components=1
-  - cd freesasa
-  - ./configure --disable-xml --disable-json --enable-python-bindings --with-python=python3.6 CFLAGS="-fPIC" --prefix=$HOME
-  - make
-  - make install
-  - cd ../
-
-
-  # install pytorch
-  - conda install pytorch=1.0 torchvision cuda80 -c soumith
-
-  # codacy-coverage
-  - pip install -q --upgrade pip
-  - pip install -q coverage
-  - pip install -q codacy-coverage
-  - pip install -q coveralls
+  # python
+  - conda install python=3.7
 
+  # install openmpi for mpi4py
+  - sudo apt-get install libopenmpi-dev openmpi-bin
 
 install:
   - pip install -qe .[test]

CHANGELOG.rst

@@ -0,0 +1,14 @@
+###########
+Change Log
+###########
+
+All notable changes to this project will be documented in this file.
+This project adheres to `Semantic Versioning <http://semver.org/>`_.
+
+[Unreleased]
+************
+
+Added
+-----
+
+* Empty Python project directory structure

CODE_OF_CONDUCT.rst

@@ -0,0 +1,79 @@
+###############################################################################
+Contributor Covenant Code of Conduct
+###############################################################################
+
+Our Pledge
+**********
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+Our Standards
+*************
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+Our Responsibilities
+********************
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+Scope
+*****
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+Enforcement
+***********
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at n.renaud@esciencecenter.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+Attribution
+***********
+
+This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_, version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

CONTRIBUTING.rst

@@ -0,0 +1,44 @@
+############################
+Contributing guidelines
+############################
+
+We welcome any kind of contribution to our software, from simple comment or question to a full fledged `pull request <https://help.github.com/articles/about-pull-requests/>`_. Please read and follow our `Code of Conduct <CODE_OF_CONDUCT.rst>`_.
+
+A contribution can be one of the following cases:
+
+#. you have a question;
+#. you think you may have found a bug (including unexpected behavior);
+#. you want to make some kind of change to the code base (e.g. to fix a bug, to add a new feature, to update documentation).
+
+The sections below outline the steps in each case.
+
+You have a question
+*******************
+
+#. use the search functionality `here <https://github.com/DeepRank/deeprank/issues>`__ to see if someone already filed the same issue;
+#. if your issue search did not yield any relevant results, make a new issue;
+#. apply the "Question" label; apply other labels when relevant.
+
+You think you may have found a bug
+**********************************
+
+#. use the search functionality `here <https://github.com/DeepRank/deeprank/issues>`__ to see if someone already filed the same issue;
+#. if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
+    - the `SHA hashcode <https://help.github.com/articles/autolinked-references-and-urls/#commit-shas>`_ of the commit that is causing your problem;
+    - some identifying information (name and version number) for dependencies you're using;
+    - information about the operating system;
+#. apply relevant labels to the newly created issue.
+
+You want to make some kind of change to the code base
+*****************************************************
+
+#. (**important**) announce your plan to the rest of the community *before you start working*. This announcement should be in the form of a (new) issue;
+#. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
+#. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions `here <https://help.github.com/articles/configuring-a-remote-for-a-fork/>`__ and `here <https://help.github.com/articles/syncing-a-fork/>`__);
+#. make sure the existing tests still work by running ``python setup.py test``;
+#. add your own tests (if necessary);
+#. update or expand the documentation;
+#. `push <http://rogerdudler.github.io/git-guide/>`_ your feature branch to (your fork of) the DeepRank repository on GitHub;
+#. create the pull request, e.g. following the instructions `here <https://help.github.com/articles/creating-a-pull-request/>`__.
+
+In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.

MANIFEST.in

@@ -0,0 +1,7 @@
+include LICENSE
+include README.md
+include deeprank/features/forcefield/*
+graft test/1AK4
+prune deeprank/utils
+include deeprank/utils/logger_helper.py
+exclude test/test_hitrate_successrate.py

NOTICE

@@ -0,0 +1,6 @@
+  DeepRank
+  Copyright [2017-2020] The Netherlands eScience Center
+
+  This product includes software developed at
+  The Netherlands eScience Center (https://www.esciencecenter.nl/)
+  For the DeepRank project