A python library to deal with scientific papers.
Phyks (Lucas Verney) 5f42e7ca6c Use journal instead of publisher for page tearing 3 years ago
docs Fix sphinx doc generation + error in doi module 3 years ago
libbmc Use journal instead of publisher for page tearing 3 years ago
.gitignore Add a setup.py file and __init__.py for module and submodules 3 years ago
.gitmodules Add some doc, especially about external dependencies 3 years ago
LICENSE Add a setup.py file and __init__.py for module and submodules 3 years ago
README.md Tearpages ok 3 years ago
requirements.txt Tearpages ok 3 years ago
setup.py Add a setup.py file and __init__.py for module and submodules 3 years ago

README.md

libBMC

Presentation

A generic Python library to manage bibliography and play with scientific papers.

Note: This library is written for Python 3 and may not work with Python 2. This is not a major priority for me, but if anyone needed to make it work with Python 2 and want to make a PR, I will happily merge it :)

Dependencies

Python dependencies are listed in the requirements.txt file at the root of this repo, and can be installed with pip install -r requirements.txt.

External dependencies are OpenDeTeX (an improved version of DeTeX) and the pdftotext and djvutxt programs.

OpenDeTeX is available as a Git submodule in the libbmc/external folder. If you do not have it installed system-wide, you can use the following steps to build it in this repo and the library will use it:

  • git submodule init; git submodule update to initialize the Git submodules.
  • cd libbmc/external/opendetex; make to build OpenDeTeX (see INSTALL file in the same folder for more info, you will need make, gcc and flex to build it).

OpenDeTeX is used to get references from a .bbl file (or directly from arXiv as it uses the same pipeline).

pdftotext and djvutxt should be available in the packages of your distribution and should be installed systemwide. Both are used to extract identifiers from papers PDF files.

If you plan on using the libbmc.citations.pdf functions, you should also install the matching software (CERMINE, Grobid or pdf-extract). See the docstrings of those functions for more infos on this particular point.

License

This code is licensed under an MIT license.

Acknowledgements

Thanks a lot to the following authors and programs for helping in building this lib: