-
Notifications
You must be signed in to change notification settings - Fork 14
Welcome Karan
John Darrington edited this page Oct 4, 2021
·
2 revisions
We're glad that you'll be working in the Deep Lynx ecosystem and we hope that your particular skills, experience, and point of view will positively benefit but us as researchers and the project as a whole.
We hope that we can make your initial experience a smooth one, so if at any time you feel lost or frustrated - please feel free to reach out and we'll be happy to help. Our goal is to help you be successful on your projects.
Below you'll find your first steps to using Deep Lynx in your local environment.
- Read Getting Started - this will go a long way in insuring that you can get a local copy of Deep Lynx up and running. If you feel like the steps are missing something, please let us know so we can edit them. Note: the particular error you're running into, at least according to our email, has something to do with the CORE_DB_CONNECTION_STRING environment variable. You will need to figure out the access credentials and access endpoint/port for the PostgreSQL database you'll be using. See this link for information on how to take that information and generate a connection string
- Setup the Admin Web GUI (if needed) - Deep Lynx ships with an SPA (single page application) web application that allows for more easily understanding and working in the Deep Lynx environment. Because I don't know the specifics of your project I can't know for sure if you need this - best left to your judgement.
- Read up on the following design patterns: Repository Pattern , Domain Object, and Data Mapper - Deep Lynx is built using these patterns and understanding them will go a long way in understanding how Deep Lynx functions.
- If you're planning on sending data to Deep Lynx - be sure to ask about the data ingestion process. Unfortunately I do not have good documentation on that at this time, but we can meet personally to go over it.
Welcome to the ecosystem!
Sections marked with ! are in progress.
- HTTP Authentication Methods
- Generating and Exchanging API Keys for Tokens
- Creating a DeepLynx Enabled OAuth2 App
- Authentication with DeepLynx Enabled OAuth2 App
- Creating an Ontology
- Creating Relationships and Relationship Pairs
- Ontology Versioning
- Ontology Inheritance
- Querying Tabular (Timeseries) Data
- Timeseries Quick Start
- Timeseries Data Source
- Timeseries Data Source via API
- Exporting Data
- Querying Data
- Querying Timeseries Data
- Querying Jazz Data
- Querying Data - Legacy
- Querying Tabular Data