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

Related tags

General Utilitiesjfc
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.

Owner
Miguel M.
Hi, nice to meet you. I study physics, program (games) and make music. You can find my portfolio below!
Miguel M.
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
Astvuln is a simple AST scanner which recursively scans a directory, parses each file as AST and runs specified method.

Astvuln Astvuln is a simple AST scanner which recursively scans a directory, parses each file as AST and runs specified method. Some search methods ar

Bitstamp Security 7 May 29, 2022
A python program to find binary, octal and hexadecimal of a decimal.

decimal-converter This little python program can convert a decimal in to, Binary Octal Hexadecimal Needed Python 3 or later or a online python compile

Chandula Janith 0 Nov 27, 2021
Python HTTP Agent Parser

Features Fast Detects OS and Browser. Does not aim to be a full featured agent parser Will not turn into django-httpagentparser ;) Usage import ht

Shekhar 213 Dec 06, 2022
Enable ++x and --x expressions in Python

By default, Python supports neither pre-increments (like ++x) nor post-increments (like x++). However, the first ones are syntactically correct since Python parses them as two subsequent +x operation

Alexander Borzunov 85 Dec 29, 2022
a tool for annotating table

table_annotate_tool a tool for annotating table motivated by wiki2bio,we create a tool to annoate all types of tables,this tool can annotate a table w

wisdom under lemon trees 4 Sep 23, 2021
A way to write regex with objects instead of strings.

Py Idiomatic Regex (AKA iregex) Documentation Available Here An easier way to write regex in Python using OOP instead of strings. Makes the code much

Ryan Peach 18 Nov 15, 2021
Check username

Checker-Oukee Check username It checks the available usernames and creates a new account for them Doesn't need proxies Create a file with usernames an

4 Jun 05, 2022
Compute the fair market value (FMV) of staking rewards at time of receipt.

tendermint-tax A tool to help calculate the tax liability of staking rewards on Tendermint chains. Specifically, this tool calculates the fair market

5 Jan 07, 2022
Dice Rolling Simulator using Python-random

Dice Rolling Simulator As the name of the program suggests, we will be imitating a rolling dice. This is one of the interesting python projects and wi

PyLaboratory 1 Feb 02, 2022
Dynamic key remapper for Wayland Window System, especially for Sway

wayremap Dynamic keyboard remapper for Wayland. It works on both X Window Manager and Wayland, but focused on Wayland as it intercepts evdev input and

Kay Gosho 50 Nov 29, 2022
SmarTool - Smart Util Tool for Python

A set of tools that keep Python sweeter.

Liu Tao 9 Sep 30, 2022
aws ec2.py companion script to generate sshconfigs with auto bastion host discovery

ec2-bastion-sshconfig This script will interate over instances found by ec2.py and if those instances are not publically accessible it will search the

Steve Melo 1 Sep 11, 2022
Small project to interact with python, C, HTML, JavaScript, PHP.

Micro Hidroponic Small project to interact with python, C, HTML, JavaScript, PHP. Table of Contents General Info Technologies Used Screenshots Usage P

Filipe Martins 1 Nov 10, 2021
Run functions in parallel easily, with their results typed correctly!

typesafe_parmap pip install pip install typesafe-parmap Run functions in parallel safely with typesafe parmap! GitHub: https://github.com/thejaminato

James Chua 3 Nov 06, 2021
A simple and easy to use collection of random python functions.

A simple and easy to use collection of random python functions.

Diwan Mohamed Faheer 1 Nov 17, 2021
Produce a simulate-able SDF of an arbitrary mesh with convex decomposition.

Mesh-to-SDF converter Given a (potentially nasty, nonconvex) mesh, automatically creates an SDF file that describes that object. The visual geometry i

Greg Izatt 22 Nov 23, 2022
Creating low-level foundations and abstractions for asynchronous programming in Python.

DIY Async I/O Creating low-level foundations and abstractions for asynchronous programming in Python (i.e., implementing concurrency without using thr

Doc Jones 4 Dec 11, 2021
A collection of tools for biomedical research assay analysis in Python.

waltlabtools A collection of tools for biomedical research assay analysis in Python. Key Features Analysis for assays such as digital ELISA, including

Tyler Dougan 1 Apr 18, 2022
This is a package that allows you to create a key-value vault for storing variables in a global context

This is a package that allows you to create a key-value vault for storing variables in a global context. It allows you to set up a keyring with pre-defined constants which act as keys for the vault.

Data Ductus 2 Dec 14, 2022