flintwebpage

FLINT project webpage source

https://github.com/flintlib/flintwebpage

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

FLINT project webpage source

Basic Info
  • Host: GitHub
  • Owner: flintlib
  • License: bsd-2-clause
  • Language: Python
  • Default Branch: master
  • Size: 1.2 MB
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 7
  • Open Issues: 2
  • Releases: 0
Created over 11 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Citation

README.md

Build system

We generate src/downloads.txt that is being used to generate ${DEST}/downloads.html. To generate the source file, run $ python3 downloads.py ${PATH_TO_DEST} where ${PATH_TO_DEST}/download is the path to the directory that contains all PDF-files and compressed releases (probably ~/apps/flintlib_org/).

Furthermore, we also generate src/citation.txt that is being used to generate ${DEST}/citation.html. To generate the source file, run $ python3 citation.py This uses HISTORY, so make sure that HISTORY is ordered and up-to-date.

Following this, generate all HTML pages via $ python3 build.py ${PATH_TO_DEST} which outputs all HTML files to ${PATH_TO_DEST} (probably ~/apps/flintlib_org/).

Source file structure

In the source directory:

  • ./: Building scripts are located in the top directory.
  • src/: Text files that are to be used to generated to HTML files.

Output file system

The following directories in the output directory ${PATH_TO_DEST} needs to be populated already:

  • img/: Images for website, such as figures and picture of authors.
  • download/: PDF documentation along with releases (.tar.gz and .zip) files.

Owner

  • Name: flintlib
  • Login: flintlib
  • Kind: organization

FLINT (Fast Library for Number Theory)

Citation (citation.py)

# citation.py: generate citation.txt

import sys
import re

if len(sys.argv) != 1:
    print("Usage:  python3 citation.py")
    exit(1)

output = "src/citation.txt"

# Read HISTORY
with open('HISTORY', 'r') as file:
    history_lines = file.read()

version = ""
year = ""

# NOTE: We do not capture 3.1.3-p1.  We just want the last proper version.
pattern = re.compile(r"(\d+)\.(\d+).(\d+)\s+(\d{4})-\d{2}-\d{2}")
for line in history_lines.splitlines():
    match = pattern.match(line)
    if match:
        version = f"{match.group(1)}.{match.group(2)}.{match.group(3)}"
        year = f"{match.group(4)}"

page = r"""<h2>Citing FLINT</h2>

<p>When citing FLINT, the following form is recommended:</p>

<blockquote>The FLINT team. FLINT: Fast Library for Number Theory, """ + year + r""".
Version """ + version + r""", https://flintlib.org.</blockquote>

<pre>
@manual{flint,
  key = {{FLINT}},
  author = {The {FLINT} team},
  title = {{FLINT}: {F}ast {L}ibrary for {N}umber {T}heory},
  year = {""" + year + r"""},
  note = {Version """ + version + r""", \url{https://flintlib.org}}
}
</pre>

<p>
Please consider also looking up whether there is a paper discussing
the specific feature(s) in FLINT which you are using. In many cases, there is such a paper!
For example, research using the ball arithmetic component of FLINT (Arb) may cite:</p>

<blockquote>
F. Johansson. "Arb: efficient arbitrary-precision midpoint-radius interval arithmetic", IEEE Transactions on Computers, 66(8):1281-1292, 2017. DOI: <a href="https://doi.org/10.1109/TC.2017.2690633">10.1109/TC.2017.2690633</a>
</blockquote>

<pre>
@article{7891956,
  author = {Fredrik Johansson},
  journal = {{IEEE} Transactions on Computers},
  title = {{A}rb: Efficient Arbitrary-Precision Midpoint-Radius Interval Arithmetic},
  year = {2017},
  volume = {66},
  number = {8},
  pages = {1281-1292},
  doi = {10.1109/TC.2017.2690633}
}
</pre>

<p>Research using FLINT's number fields may cite:</p>

<blockquote>William B. Hart. "ANTIC: Algebraic number theory in C", Computeralgebra-Rundbrief: Vol. 56, 2015</blockquote>

<p>Many other references can be found <a href="https://www.flintlib.org/doc/references.html">in the bibliography of the FLINT documentation</a>.</p>

<p>For a list of changes in each release, see the <a href="https://www.flintlib.org/doc/history.html">history</a> section of the documentation.</p>
"""

with open(output, "w") as file:
    file.write(page)

GitHub Events

Total
  • Delete event: 1
  • Member event: 1
  • Push event: 18
  • Pull request event: 13
  • Create event: 1
Last Year
  • Delete event: 1
  • Member event: 1
  • Push event: 18
  • Pull request event: 13
  • Create event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • albinahlback (5)
  • fingolfin (2)
  • inkydragon (1)
  • fredrik-johansson (1)
Top Labels
Issue Labels
Pull Request Labels