forked from MDAnalysis/mdanalysis
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
moved analysis.x3dna to analysis.legacy.x3dna (MDAnalysis#987)
* moved analysis.x3dna to analysis.legacy.x3dna - created new MDAnalysis.analysis.legacy package - directory - docs - x3dna is now considered legacy code (no/minimal testing, no maintenance) - see MDAnalysis#906 for reasons (mainly because the x3dna license does not allow us to just install it for testing on travis, or rather, licensing and access to x3dna is unknown/too complicated) - closes MDAnalysis#906 - see MDAnalysis#743 on background for legacy code and also https://github.com/MDAnalysis/mdanalysis/wiki/Style-Guide#tests-for-mdanalysisanalysis - added stub with deprecation warning: until release 1.0, MDAnalysis.analysis.x3dna is still accessible - added test case that the stub is there * updated CHANGELOG - legacy module (MDAnalysis#743) - x3dna is now legacy code (MDAnalysis#906) - updated upcoming release number to 0.16.0 [skip ci] * Removed legacy submodule from coverage
- Loading branch information
1 parent
87857c1
commit 83ab284
Showing
9 changed files
with
858 additions
and
722 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ omit = | |
*/migration/* | ||
*/visualization/* | ||
*/MDAnalysis/tests/* | ||
|
||
*/legacy/* | ||
|
||
[report] | ||
exclude_lines = | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# -*- Mode: python; tab-width: 4; indent-tabs-mode:nil; coding:utf-8 -*- | ||
# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4 | ||
# | ||
# MDAnalysis --- http://www.MDAnalysis.org | ||
# Copyright (c) 2006-2015 Naveen Michaud-Agrawal, Elizabeth J. Denning, Oliver Beckstein | ||
# and contributors (see AUTHORS for the full list) | ||
# | ||
# Released under the GNU Public Licence, v2 or any higher version | ||
# | ||
# Please cite your use of MDAnalysis in published work: | ||
# | ||
# N. Michaud-Agrawal, E. J. Denning, T. B. Woolf, and O. Beckstein. | ||
# MDAnalysis: A Toolkit for the Analysis of Molecular Dynamics Simulations. | ||
# J. Comput. Chem. 32 (2011), 2319--2327, doi:10.1002/jcc.21787 | ||
# | ||
|
||
""":mod:`MDAnalysis.analysis.legacy` --- Legacy analysis code | ||
========================================================== | ||
.. versionadded:: 0.16.0 | ||
The :mod:`MDAnalysis.analysis.legacy` package contains analysis | ||
modules that are not or only incompletely tested and not regularly | ||
maintained. They nevertheless still provide useful and sometimes | ||
unique analysis capabilities and are therefore provided **as is**. | ||
.. warning:: | ||
Code in this module is not regularly maintained. Please use it very | ||
carefully. | ||
If you want to use code from this module then you will have to import | ||
it explicitly. For example, :: | ||
from MDAnalysis.analysis.legacy import x3dna | ||
(For further discussion, see `Issue 743`_.) | ||
.. _Issue 743: https://github.com/MDAnalysis/mdanalysis/issues/743 | ||
""" |
Oops, something went wrong.