jfc is an utility to make reviewing ArXiv papers for your Journal Club easier.

Overview

Journal Fabulous Club

jfc is an utility to make reviewing ArXiv papers for your Journal Club easier.

demo

Install

Consider using pipx.

pipx install git+https://github.com/mikeevmm/jfc/

Otherwise, if you are using pip:

pip install git+https://github.com/mikeevmm/jfc/

How to Use

jfc aggregates unseen articles from the specified timeframe (see the configuration section), and displays them to you in an interactive prompt. From the title, you can choose to read the abstract, and from there you can choose to open the ArXiv PDF.

Run jfc to get an interactive prompt.

Configuration

jfc has some configuration parameters, which are set in the TOML file that lives in the configuration directory (as reported by appdirs).

Running jfc config will output the full path of the configuration file. Since most editors accept a path as an argument for the file to open, this means you can quickly edit the configuration (in bash) with

<your favourite editor> $(jfc config)

To clean the configuration and/or article database, run one of

jfc clean conf
jfc clean db
jfc clean all

A copy of the old files is kept with a .old extension, so that these can be recovered. In particular, your old configuration can be recovered (in bash) with

mv "$(jfc config).old" "$(jfc config)"

Parameters

  • span The timeframe of publication dates to aggregate, in days, and counting backwards from today. [Default: 7]
  • show_header Whether to be boring (false) or not (true) [Default: true]
  • [categories] Set each item below it to true to include it in the ArXiv search. Every element defaults to false, except quant-ph, which defaults to true.
    • cs
    • econ
    • eess
    • math
    • astro-ph
    • cond-mat
    • gr-qc
    • hep-ex
    • hep-lat
    • hep-ph
    • hep-th
    • math-ph
    • nlin
    • nucl-ex
    • nucl-th
    • physics
    • quant-ph
    • q-bio
    • q-fin
    • stat

Contributing

Pull requests are welcome. Issues are not guaranteed to be addressed. jfc is built primarily for self-use, provided to you for free, and not my primary occupation. Please respect this.

Licence

jfc is licenced under a GNU General Public License, version 3. This informally means that:

You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

You can find a copy of the licence under LICENCE.

Support

We're all poor students, so we know how this goes. Nonetheless, getting donations, no matter how small, lets me know that people use and appreciate the software I've published.

💕 If you like and use jfc, consider buying me a coffee.

You might also like...
Utility to play with ADCS, allows to request tickets and collect information about related objects.

certi Utility to play with ADCS, allows to request tickets and collect information about related objects. Basically, it's the impacket copy of Certify

Modest utility collection for development with AIOHTTP framework.

aiohttp-things Modest utility collection for development with AIOHTTP framework. Documentation https://aiohttp-things.readthedocs.io Installation Inst

Collection of code auto-generation utility scripts for the Horizon `Boot` system module

boot-scripts This is a collection of code auto-generation utility scripts for the Horizon Boot system module, intended for use in Atmosphère. Usage Us

Python utility for discovering interesting CFPreferences values on iDevices

Description Simple utility to search for interesting preferences in iDevices. Installation python3 -m pip install -U --user cfprefsmon Example In this

This is Cool Utility tools that you can use in python.

This is Cool Utility tools that you can use in python. There are a few tools that you might find very useful, you can use this on pretty much any project and some utils might help you a lot and save so much time since it’s a simple function.

Build capture utility for Linux

CX-BUILD Compilation Database alternative Build Prerequisite the CXBUILD uses linux system call trace utility called strace which was customized. So I

MongoDB utility to inflate the contents of small collection to a new larger collection

MongoDB Data Inflater ("data-inflater") The data-inflater tool is a MongoDB utility to automate the creation of a new large database collection using

A utility tool to create .env files

A utility tool to create .env files dump-env takes an .env.template file and some optional environmental variables to create a new .env file from thes

Yet another retry utility in Python

Yet another retry utility in Python, avereno being the Malagasy word for retry.

Comments
  • Suggest to loosen the dependency on halo

    Suggest to loosen the dependency on halo

    Hi, your project jfc(commit id: ceae86ed2a3e28349a5998fc2e80de8a94929c24) requires "halo==0.0.31" in its dependency. After analyzing the source code, we found that the following versions of halo can also be suitable, i.e., halo 0.0.30, since all functions that you directly (1 APIs: halo.halo.Halo.init) or indirectly (propagate to 8 halo's internal APIs and 6 outsider APIs) used from the package have not been changed in these versions, thus not affecting your usage.

    Therefore, we believe that it is quite safe to loose your dependency on halo from "halo==0.0.31" to "halo>=0.0.30,<=0.0.31". This will improve the applicability of jfc and reduce the possibility of any further dependency conflict with other projects.

    May I pull a request to further loosen the dependency on halo?

    By the way, could you please tell us whether such an automatic tool for dependency analysis may be potentially helpful for maintaining dependencies easier during your development?

    opened by Agnes-U 1
Owner
Miguel M.
Hi, nice to meet you. I study physics, program (games) and make music. You can find my portfolio below!
Miguel M.
EVE-NG tools, A Utility to make operations with EVE-NG more friendly.

EVE-NG tools, A Utility to make operations with EVE-NG more friendly. Also it support different snapshot operations with same style as Libvirt/KVM

Bassem Aly 8 Jan 5, 2023
jsoooooooon derulo - Make sure your 'jason derulo' is featured as the first part of your json data

jsonderulo Make sure your 'jason derulo' is featured as the first part of your json data Install: # python pip install jsonderulo poetry add jsonderul

jesse 3 Sep 13, 2021
This utility lets you draw using your laptop's touchpad on Linux.

FingerPaint This utility lets you draw using your laptop's touchpad on Linux. Pressing any key or clicking the touchpad will finish the drawing

Wazzaps 95 Dec 17, 2022
A small utility that sorts your files.

FileSorter A small utility that sorts your files. TODO: Scan directory to find files(thanks @corruptmemry for this!) Split extensions to determine fil

null 2 Jun 16, 2022
Parse URLs for DOIs, PubMed identifiers, PMC identifiers, arXiv identifiers, etc.

citation-url Parse URLs for DOIs, PubMed identifiers, PMC identifiers, arXiv identifiers, etc. This module has a single parse() function that takes in

Charles Tapley Hoyt 2 Feb 12, 2022
A script to check for common mistakes in LaTeX source files of scientific papers.

LaTeX Paper Linter This script checks for common mistakes in LaTeX source files of scientific papers. Usage python3 paperlint.py <file.tex> [-i/x <inc

Michael Schwarz 12 Nov 16, 2022
Make your functions return something meaningful, typed, and safe!

Make your functions return something meaningful, typed, and safe! Features Brings functional programming to Python land Provides a bunch of primitives

dry-python 2.6k Jan 9, 2023
A Python utility belt containing simple tools, a stdlib like feel, and extra batteries. Hashing, Caching, Timing, Progress, and more made easy!

Ubelt is a small library of robust, tested, documented, and simple functions that extend the Python standard library. It has a flat API that all behav

Jon Crall 638 Dec 13, 2022
isort is a Python utility / library to sort imports alphabetically, and automatically separated into sections and by type.

isort is a Python utility / library to sort imports alphabetically, and automatically separated into sections and by type. It provides a command line utility, Python library and plugins for various editors to quickly sort all your imports.

Python Code Quality Authority 5.5k Jan 8, 2023
Utility to extract Fantasy Grounds Unity Line-of-sight and lighting files from a Univeral VTT file exported from Dungeondraft

uvtt2fgu Utility to extract Fantasy Grounds Unity Line-of-sight and lighting files from a Univeral VTT file exported from Dungeondraft This program wo

Andre Kostur 29 Dec 5, 2022