Skip to content

ResearchMap is an open source visualization tool designed to visualize research collaborations between researchers.

License

Notifications You must be signed in to change notification settings

DonKamilo00/ResearchMap

Repository files navigation

ResearchMap

ResearchMap is an open source visualization tool designed to visualize research collaborations between researchers. The project is currently in the early stages of development, and contributions are welcome!

Features

  • Search and Select Researcher: Allows users to search and select a researcher using an API. (Completed)
  • Networking Visualization: Displays a network visualization based on the selected researcher. (Work in progress)
  • Website Frontend: Development of the frontend interface. (To be done)

More features are planned for future updates.

Installation

To get started with ResearchMap, ensure you have Python and Flask installed on your machine.

  1. Clone the repository:

    git clone https://github.com/your-username/ResearchMap.git
    cd ResearchMap
  2. Activate a virtual environment:

    source .venv/bin/activate  # On Windows, use `.venv\Scripts\activate`
  3. Install the required dependencies:

    pip install -r requirements.txt
  4. Run the Flask application:

    flask --app app run

Usage

Once the application is running, open your web browser and navigate to http://127.0.0.1:5000 to start using ResearchMap.

Contributing

We welcome contributions from the community! If you are interested in contributing, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add new feature').
  5. Push to the branch (git push origin feature-branch).
  6. Open a pull request.

Please make sure to follow the contributing guidelines and code of conduct.

License

This project is licensed under the GLP 3.0 License. See the LICENSE file for details.

Contact

If you have any questions or feedback, feel free to reach out to us at:

Screenshots

Here are some screenshots of the current state of the project:

Search Researcher Search and select a researcher

Network Visualization Network visualization of researcher collaborations

Technologies Used

  • Python
  • Flask
  • D3.js (or another visualization library, if applicable)
  • HTML/CSS/JavaScript

Thank you for checking out ResearchMap! We look forward to your contributions and feedback.