scholarly-infrastructure 0.1.1

所谓大学者，非谓有大楼之谓也，有大师之谓也。

大师荟萃之楼 Scholarly Infrastructure

“所谓大学者，非谓有大楼之谓也，有大师之谓也。” ——梅贻琦

“A first-class university is not top for its grand infrastuctures, but by its great scholars.” —— Mei Yiqi

Inspired by the timeless wisdom of Mei Yiqi, Scholarly Infrastructure is a foundational library designed to support and accelerate research projects within our laboratory.

🌟 Introduction

Scholarly Infrastructure aims to provide a robust and modular foundation for all projects in our research group. It centralizes common utilities, tools, and workflows, enabling seamless collaboration and reducing redundant development effort. By building on this infrastructure, researchers can focus more on innovation and experimentation rather than re-implementing fundamental components.

🔑 Key Features

• 📚 Common Utilities: Ready-to-use tools for data processing, visualization, and analysis.
• ⚙️ Modular Design: Highly reusable modules that can be integrated across diverse projects.
• 🚀 Performance Optimization: Optimized algorithms and workflows for research tasks.
• 🔒 Scalable and Reliable: Built to handle the increasing complexity of modern research.
• 🛠️ Customizable: Easy to extend and tailor to specific project needs.

📦 Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/THU-CVML/ScholarlyInfrastructure.git

or from conda

$ conda install -c yecanming6666 scholarly_infrastructure

or from pypi

$ pip install scholarly_infrastructure

📖 Usage

Documentation

Documentation currently not available.

Quick Start

Here’s a quick example to get started:

1+1

2

🤝 Contributing

Contributions are welcome! Here’s how you can quickly get involved. Please review our contribution guidelines for more details.

git guide

1. Fork the repository and then git clone it to your local machine: git clone https://github.com/your-username/ScholarlyInfrastructure.git.
2. Create a new branch for your feature or bug fix: git checkout -b feature-name.
3. Commit your changes: git commit -m "Add feature-name".
4. Push your branch: git push origin feature-name.
5. Open a pull request and describe your changes.

---

nbdev framework guide

Our project utilizes nbdev to manage our codes, tests and documentation. If you are new to using nbdev here are some quich points to get you started.

1. Install this libary in Development mode

After you have cloned the repository, and before you start working on it, you need to pip install this library in development mode. This can be done using the following command:

# make sure NamableClassify package is installed in development mode
$ pip install -e .[dev]

2. make changes under notebooks/ directory

use #| export for exported codes.

3. check and synchronize before git commit

# compile to have changes apply to the python module
$ nbdev_prepare

📜 License

This project is licensed under the Apache 2.0 License. You are free to use, modify, and distribute this software under the terms, provided you comply with the license’s conditions, including giving credit to the original authors and not using their trademarks.

Let Scholarly Infrastructure be the foundation that powers your next groundbreaking discovery. Together, we build not just tools, but a thriving research ecosystem. ✨