2
2
permuta
3
3
#######
4
4
5
- .. image :: https://travis-ci.org /PermutaTriangle/Permuta.svg?branch=master
6
- :alt: Travis
7
- :target: https://travis-ci.org /PermutaTriangle/Permuta
5
+ .. image :: https://github.com /PermutaTriangle/Permuta/workflows/tests/badge .svg
6
+ :alt: Tests
7
+ :target: https://github.com /PermutaTriangle/Permuta/actions
8
8
.. image :: https://img.shields.io/pypi/v/Permuta.svg
9
9
:alt: PyPI
10
10
:target: https://pypi.python.org/pypi/Permuta
11
11
.. image :: https://img.shields.io/pypi/l/Permuta.svg
12
12
:target: https://pypi.python.org/pypi/Permuta
13
13
.. image :: https://img.shields.io/pypi/pyversions/Permuta.svg
14
14
:target: https://pypi.python.org/pypi/Permuta
15
- .. image :: http ://img.shields.io/badge/readme-tested-brightgreen .svg
16
- :alt: Travis
17
- :target: https://travis-ci.org/PermutaTriangle/Permuta
18
- .. image :: https ://requires.io/github/PermutaTriangle/Permuta/requirements .svg?branch=master
19
- :target: https://requires.io/github/PermutaTriangle/Permuta/requirements/?branch=master
20
- :alt: Requirements Status
15
+ .. image :: https ://img.shields.io/badge/code%20style-black-000000 .svg
16
+ :alt: Code style: black
17
+ :target: https://github.com/psf/black
18
+ .. image :: http ://www.mypy-lang.org/static/mypy_badge .svg
19
+ :alt: Checked with mypy
20
+ :target: http://mypy-lang.org/
21
21
.. image :: https://zenodo.org/badge/DOI/10.5281/zenodo.4725758.svg
22
22
:target: https://doi.org/10.5281/zenodo.4725758
23
23
24
24
Permuta is a Python library for working with perms (short for permutations),
25
25
patterns, and mesh patterns.
26
26
27
27
If this code is useful to you in your work, please consider citing it. To generate a
28
- BibTeX entry (or another format), click the "DOI" badge above and locate the "Cite As "
28
+ BibTeX entry (or another format), click the "DOI" badge above to go to ` Zenodo `_ and locate the "Export "
29
29
section.
30
30
31
+ .. _Zenodo : https://doi.org/10.5281/zenodo.4725758
32
+
31
33
If you need support, you can join us in our `Discord support server `_.
32
34
33
35
.. _Discord support server : https://discord.gg/ngPZVT5
@@ -46,14 +48,13 @@ source code, in which case you run the following after cloning the repository:
46
48
47
49
.. code-block :: bash
48
50
49
- ./setup.py develop
51
+ pip install -e .
50
52
51
53
To run the unit tests:
52
54
53
55
.. code-block :: bash
54
56
55
- pip install -r test_requirements.txt
56
- ./setup.py test
57
+ tox
57
58
58
59
Using Permuta
59
60
#############
@@ -65,7 +66,7 @@ interactive Python session, just like any other Python library:
65
66
66
67
>> > from permuta import *
67
68
68
- Importing ``* `` from it supplies you with the 'Perm' and 'PermSet'
69
+ Importing ``* `` supplies you with the 'Perm' and 'PermSet'
69
70
classes along with the 'AvoidanceClass' class (with alias 'Av') for generating
70
71
perms avoiding a set of patterns. It also gives you the 'MeshPatt' class
71
72
and some other submodules which we will not discuss in this readme.
@@ -178,7 +179,7 @@ There are numerous practical methods available:
178
179
Creating a perm class
179
180
#####################
180
181
181
- Perm classes are specified with a basis:
182
+ Perm classes are created by first specifying a basis and then calling the 'Av' class, to create the set of permutations avoiding the basis:
182
183
183
184
.. code-block :: python
184
185
@@ -227,6 +228,8 @@ given class.
227
228
Enumeration of Permutation Classes and Weighted Labelled Independent Sets: Corollary 4.6
228
229
The class contains only finitely many simple permutations
229
230
231
+ The output is the name of a paper, followed by the statement in the paper where the enumeration strategy is discussed or stated.
232
+
230
233
Permutation statistics
231
234
######################
232
235
@@ -520,12 +523,3 @@ License
520
523
521
524
BSD-3: see the `LICENSE <https://github.com/PermutaTriangle/Permuta/blob/master/LICENSE >`_ file.
522
525
523
- Citing
524
- ######
525
-
526
- If you found this library helpful with your research and would like to cite us,
527
- you can use the following `BibTeX `_ or go to `Zenodo `_ for alternative formats.
528
-
529
- .. _BibTex : https://zenodo.org/record/4945792/export/hx#.YImTibX7SUk
530
-
531
- .. _Zenodo : https://doi.org/10.5281/zenodo.4725758
0 commit comments