Skip to content

Commit b6097db

Browse files
authored
Move and remove modules (#524)
1 parent 1e67cea commit b6097db

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+376
-7046
lines changed

.codecov.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ coverage:
33
- "examples/.*"
44
- "src/maicos/_version.py"
55
- "tests/.*"
6-
- "versioneer.py"
76
status:
87
project:
98
default:

.github/workflows/build.yml

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ on:
66
# build wheels in PR if this file changed
77
- ".github/workflows/build.yml"
88
# build wheels in PR if any of the build system files changed
9-
- "**/setup.py"
109
- "**/pyproject.toml"
1110
- "**/MANIFEST.in"
1211
schedule:
@@ -16,29 +15,8 @@ on:
1615
# allow manual triggering of the workflow
1716

1817
jobs:
19-
build-wheels:
20-
name: wheels / ${{ matrix.os }}
21-
runs-on: ${{ matrix.os }}
22-
strategy:
23-
matrix:
24-
# macos-13 is an intel runner, macos-15 is apple silicon
25-
os: [ubuntu-24.04, ubuntu-24.04-arm, windows-2025, macos-13, macos-15]
26-
27-
steps:
28-
- uses: actions/checkout@v5
29-
with:
30-
fetch-depth: 0
31-
32-
- name: Build wheels
33-
uses: pypa/cibuildwheel@v3.2.1
34-
35-
- uses: actions/upload-artifact@v5
36-
with:
37-
name: wheel-${{ matrix.os }}
38-
path: ./wheelhouse/*.whl
39-
40-
build-sdist:
41-
name: sdist
18+
build:
19+
name: build
4220
runs-on: ubuntu-latest
4321

4422
steps:
@@ -55,18 +33,20 @@ jobs:
5533
- name: Install dependencies
5634
run: python -m pip install tox
5735

58-
- name: Test build integrity and create sdist
36+
- name: Test build integrity and build sdist
5937
run: tox -e build
6038

6139
- uses: actions/upload-artifact@v5
6240
with:
63-
name: sdist
64-
path: dist/*.tar.gz
41+
name: files
42+
path: |
43+
dist/*.tar.gz
44+
dist/*.whl
6545
6646
release:
6747
name: Release package
6848
if: startsWith(github.ref, 'refs/tags/v') && github.event_name == 'workflow_dispatch'
69-
needs: [build-wheels, build-sdist]
49+
needs: [build]
7050
runs-on: ubuntu-latest
7151
environment:
7252
name: pypi

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ __pycache__/
2020
build/
2121
dist/
2222
sg_execution_times.rst
23+
_version.py
2324

2425
# Allow maicos share text files
2526
!maicos/share/*.dat

CHANGELOG.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ Unreleased
1313
----------
1414
Philip Loche, Kira Fischer, Francis Jose, Philipp Staerk, Henrik Stooß
1515

16+
- Move ``DielectricSpectrum``, ``lib.math.FT``, ``lib.math.iFT`` to spectrakit package.
17+
(#524)
18+
- Move ``Saxs``, ``DiporderStructureFactor``, ``RDFDiporder``, ``lib.math.atomic_form_factor``,
19+
``lib.math.rdf_structure_factor``, to scatterkit package. (#524)
20+
- Remove ``KineticEnergy`` and ``DipoleAngle`` module. (#524)
1621
- Implement error calculation for observables with multiple samples (#494)
1722
- Bump minimal Python version to 3.11 and MDAnalysis to 2.10.0 (#529)
1823
- Added support for Python 3.14 in CI workflows (#529)

MANIFEST.in

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
1-
graft docs
21
graft src
32

4-
# If you are encounter problems with .c file use
5-
# git update-index --assume-unchanged src/maicos/lib/*.c
6-
73
include *.rst
84
include LICENSE
9-
include versioneer.py
105

116
prune .tox
127
prune developer
8+
prune docs
139
prune examples
1410
prune tests
1511
prune benchmarks
@@ -21,5 +17,3 @@ exclude .readthedocs.yml
2117
exclude .codecov.yml
2218
exclude tox.ini
2319
exclude asv.conf.json
24-
25-
global-exclude *.py[cod] __pycache__/* *.so *.dylib

README.rst

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ MAICoS
1313
**MAICoS** stands for **Molecular Analysis for Interfacial and Confined Systems**. It is
1414
an object-oriented **Python** toolkit for analyzing the structure and dynamics of
1515
interfacial and confined fluids from molecular simulations. Combined with `MDAnalysis`_,
16-
MAICoS enables the extraction of density profiles, dielectric constants, structure
17-
factors, and transport properties from trajectory files generated by LAMMPS, GROMACS,
18-
CHARMM, or NAMD simulations. MAICoS is open source and released under the **GNU General
19-
Public License v3.0**.
16+
MAICoS enables the extraction of density profiles, dielectric constants, and transport
17+
properties from trajectory files generated by LAMMPS, GROMACS, CHARMM, or NAMD
18+
simulations. MAICoS is open source and released under the **GNU General Public License
19+
v3.0**.
2020

2121
MAICoS is designed both for beginners in molecular simulations with no prior Python
2222
experience— offering a descriptive **Command Line Interface (CLI)**—and for experienced
@@ -104,12 +104,8 @@ Currently, MAICoS supports the following analysis modules (alphabetically):
104104
- Cylindrical dielectric profiles
105105
* - DielectricPlanar
106106
- Planar dielectric profiles
107-
* - DielectricSpectrum
108-
- Linear dielectric spectrum
109107
* - DielectricSphere
110108
- Spherical dielectric profiles
111-
* - DipoleAngle
112-
- Time series of dipole moment angles
113109
* - DiporderCylinder
114110
- Cylindrical dipolar order parameters
115111
* - DiporderPlanar
@@ -118,16 +114,10 @@ Currently, MAICoS supports the following analysis modules (alphabetically):
118114
- Spherical radial distribution function between dipoles
119115
* - DiporderSphere
120116
- Spherical dipolar order parameters
121-
* - DiporderStructureFactor
122-
- Structure factor for dipoles
123-
* - KineticEnergy
124-
- Time series of kinetic energies
125117
* - PDFCylinder
126118
- Cylindrical shell-wise 1D pair distribution functions
127119
* - PDFPlanar
128120
- Slab-wise planar 2D pair distribution functions
129-
* - Saxs
130-
- Small-angle X-ray scattering (SAXS): structure factors and scattering intensities
131121
* - TemperaturePlanar
132122
- Temperature profiles in a Cartesian geometry
133123
* - VelocityCylinder

developer/check_changelog.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#!/usr/bin/env python3
1+
#!/usr/bin/env python
22
"""Check if the CHANGELOG has been modified with respect to the main branch."""
33
import os
44

developer/clean_dist_check.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#!/usr/bin/env python3
1+
#!/usr/bin/env python
22
"""Clean dist files after tox -e build."""
33
from pathlib import Path
44

docs/src/analysis-modules/dielectricspectrum.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/src/analysis-modules/dipoleangle.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)