https://github.com/childmindresearch/cross-species-mapper

A webapp for translational exploration between humans and macaques.
https://github.com/childmindresearch/cross-species-mapper

Last synced: about 2 months ago
JSON representation

A webapp for translational exploration between humans and macaques.

• Host: GitHub
• URL: https://github.com/childmindresearch/cross-species-mapper
• Owner: childmindresearch
• License: lgpl-2.1
• Created: 2023-06-16T20:38:37.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-22T20:32:10.000Z (2 months ago)
• Last Synced: 2024-07-25T05:37:24.834Z (2 months ago)
• Language: Python
• Homepage:
• Size: 882 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Cross Species Mapper

This is the README file for the Cross Species Mappper project. It provides a webapp for an interactive mapper which transforms the cognitive ontology between humans and macaques to provide translational exploration.

## Installation

To install the project for local development, follow these steps:

1. Clone the repository to your local machine.

2. From the `frontend` directory, install the required dependencies using `npm install`.

3. Install `poetry` with `pip install poetry`.

4. From the api directory, install the required dependencies with

   `poetry install`.

5. Start the frontend server by going into the `frontend` directory and typing `npm run dev`.

6. Start the api server by going into the `api` directory and

   typing `poetry run uvicorn src.main:app --reload`.

## Usage

The intended usage of this repository is through its Docker Compose.

1. Install Docker Compose if you haven't already. You can download it from the Docker website.

2. From the root directory of the project, run docker-compose up to start the application. This will build and start all of the services defined in the docker-compose.yml file.

3. Access the frontend by navigating to http://localhost:3000 in your web browser.

4. Access the API OpenAPI specification by navigating to http://localhost:8000/docs in your web browser.

## Code Architecture

The architecture of this project is fairly small. It uses a Svelte frontend for displaying the webpage. This frontend communicates with an API based on Python's FastAPI.

```mermaid

flowchart TD

    Svelte <--> FastAPI

    FastAPI <--> Azure[Azure Blob]

```

## Contributing

Before contributing, please see our contribution guidelines in CONTRIBUTING.md in the root of this repository. To contribute to the project, follow these steps.

1. Fork the repository.

2. Create a new branch for your changes.

3. Make your changes and commit them.

4. Push your changes to your fork.

5. Submit a pull request to the main repository.

## License

This project is licensed under the L-GPL V2.1 license. See the LICENSE file for details.