Getting Started

lpm is under heavy development, it’s job is to simplify tracking of documents for academics and students. Documents can be added by providing a URL from a supported service, or via document indentification.

Installing lpm

As the software is currently under active development, it cannot be installed from pypi directly. If you wish to test the software will need to clone the repository and install it into your local path:

$ git clone https://git.fossgalaxy.com/academic/lpm.git
$ cd lpm
$ pip install -e .

You will need to ensure that ~/.local/bin is on your $PATH if you haven’t done so already.

Adding new papers

To add a new paper, you should use the lpm add command. This accepts either:

  • A url from a supported service (currently IEEE xplore)

  • An ID from a supported service with a prefix before it.

To add documents:

# To add a document via doi, use doi: followed by the ID
$ lpm add doi:10.1109/cec.2017.7969465

# to add a document via IEEE id, use ieee:
$ lpm add ieee:7969465

# You can also use the IEEE explore url:
$ lpm add https://ieeexplore.ieee.org/abstract/document/7969465

This will create a folder for the paper and pre-populate the meta.yaml file with the metadata from the service.

There is some (limited) support for de-duplication. Attempting to add the same document twice should result in the document only appearing in the library once.

Listing papers

running the command lpm list will show all papers currently in your library.

$ lpm list
doi                                   title                                                           authors                         year
10.1109/cig.2019.8848097              Re-determinizing MCTS in Hanabi                                 Goodman                         2019
10.4169/math.mag.88.5.323             How to Make the Perfect Fireworks Display: Two Strategies fo    Cox et al.                       -1
10.1109/cig.2019.8847944              Diverse Agents for Ad-Hoc Cooperation in Hanabi                 Canaan et al.                   2019
10.1016/j.tcs.2017.02.024             Hanabi is NP-hard, even for cheaters who look at their cards    Baffier et al.                  2016
10.1016/j.artint.2019.103216          The Hanabi challenge: A new frontier for AI research            Bard et al.                      -1
10.1109/cig.2017.8080417              An intentional AI for hanabi                                    Eger, Martens and Cordoba       2017
10.1109/cec.2017.7969465              Evaluating and modelling Hanabi-playing agents                  Walton-Rivers et al.            2019
10.1109/cig.2018.8490449              Evolving Agents for the Hanabi 2018 CIG Competition             Canaan et al.                   2017
10.1109/CIG.2015.7317949              The geometry friends game AI competition                        Prada et al.                    2017
10.1007/978-3-319-67468-1_7           Aspects of the Cooperative Card Game Hanabi                     van den Bergh et al.             -1

This list is generated based on the contents of files called meta.yml in your papers directory.

Getting infomation on a paper

If you wish to inspect infomation on a given paper, you can do so via the lpm info command:

$ lpm info doi:10.1109/cig.2019.8848097