opentldr

An Open Framework for Generating an Tailored Daily Report

https://github.com/opentldr/opentldr

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 (9.5%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

An Open Framework for Generating an Tailored Daily Report

Basic Info
  • Host: GitHub
  • Owner: OpenTLDR
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 3.97 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 2
Created almost 2 years ago · Last pushed about 1 year ago
Metadata Files
Readme Citation

Docs/README.md

Initialize and Import an OpenTLDR Knowledge Graph

The KnowledgeGraph() contructor should be called without parameters so that it defaults to using .env and environment variables. The order of is:

1 Set in KnowledgeGraph() constructor

  • You can set each variable and it will create the driver
  • You can setup a neo4j driver instance and pass that in
  • We advise NOT using this method , as your notebook's code will overrule the automation configurations

2 Set as Environment variable - This is how several automated processes operate, but this is not intended for most users

3 Set in the .env file (in project directory) - This is the recommended place for you to set system-specific things! - This file is not part of the GitHub repository you cloned, instead you or a setup script must create it (usually this is done by copying the DefaultDotEnv file to .env (e.g., cp ./DefaultDotEnv ./.env))

4 Defaults that are hard coded will work with the provided neo4j container setup, but probably not much else:

| Variable | Value | Description | |---|---|---| | NEO4JCONNECTION | 'bolt://localhost:7687' | URL for bolt protocol on default port of localhost only | | NEO4JUSERNAME | neo4jUser | user and password are not used for default localhost only container | | NEO4JPASSWORD | neo4jPassword | user and password are not used for default localhost only container | | NEO4JDATABASE | neo4j | community edition of neo4j ONLY allows one database |

Owner

  • Name: OpenTLDR
  • Login: OpenTLDR
  • Kind: organization
  • Email: chris@opentldr.org
  • Location: United States of America

OpenTLDR is an open source research framework for automating the generation of a tailored daily report.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Argenta"
  given-names: "Chris"
  orcid: "https://orcid.org/0009-0003-9390-2635"
title: "OpenTLDR - an open research framework for generating tailored daily reports"
date-released: 2024-04-01
url: "https://github.com/RockfishResearch/OpenTLDR"

GitHub Events

Total
  • Member event: 1
  • Push event: 5
  • Create event: 1
Last Year
  • Member event: 1
  • Push event: 5
  • Create event: 1