Data

Tools

Indexes

Applications

Experiments

Open Source Science

django-bim

Django BIM

https://github.com/starling-cloud/django-bim

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 (19.0%) to scientific vocabulary

Keywords

aec bim building-information-modelling django ifc industry-foundation-classes python starling
Last synced: 6 months ago · JSON representation ·

Repository

Django BIM

Basic Info
  • Host: GitHub
  • Owner: starling-cloud
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage: https://djangobim.com
  • Size: 2.13 MB
Statistics
  • Stars: 3
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
aec bim building-information-modelling django ifc industry-foundation-classes python starling
Created over 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security

README.md

Django BIM

Django BIM is a Django plugin designed to manage building data based on Industry Foundation Classes (IFC). This plugin provides an easy-to-use interface for integrating and managing IFC data within Django applications.

Features

  • IFC Integration: Seamlessly import and manage IFC files in your Django projects.
  • Data Visualization: Tools for visualizing building data directly from IFC files.
  • Query Interface: Advanced search and query functionalities for IFC data.

Installation

To install Django BIM, you can use pip:

bash pip install django-bim

Alternatively, if you want to install from source:

bash git clone https://github.com/starling-cloud/django-bim.git cd django-bim poetry install

Quick Start

To get started with Django BIM, add it to your installed apps in your Django settings:

python INSTALLED_APPS = [ ... 'django-bim', ... ]

Usage

Here is a basic example of how to use Django BIM in your project:

```python

Example usage code here

```

Documentation

For full documentation, visit docs-link.

Contributing

Contributions are welcome! Please read our Contributing Guide for details on how to contribute.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Authors

Notes

  • Installation: Make sure the installation instructions are correct. You might need to adjust them depending on how you configure your package deployment and whether you use pip or another method like Poetry.
  • Quick Start and Usage: Provide actual usage examples that will help new users quickly integrate and test your plugin.
  • Documentation: Link to your detailed documentation if available. It might be hosted on platforms like Read the Docs or a GitHub wiki.
  • Contributing: Create a CONTRIBUTING.md file if you plan to open up for community contributions. This file should detail how to contribute to the project.
  • License: Verify the link to the LICENSE file works correctly. You should have a LICENSE file at the root of your repository.
  • Acknowledgments: Customize this section as necessary to recognize contributors or inspirations for the project.

Adjust the README.md as needed to fit the specifics of your project and its community or organizational requirements.

Resources

  • https://ifc43-docs.standards.buildingsmart.org/IFC/RELEASE/IFC4x3/HTML/content/introduction.htm
  • https://github.com/buildingSMART/ifc-validation-data-model

Owner

  • Name: Starling
  • Login: starling-cloud
  • Kind: organization
  • Email: info@starling.associates
  • Location: Netherlands

Insight + Strategy + Design

Citation (CITATION.cff) 

cff-version: 1.2.0
title: Django BIM
version: 0.0.1
date-released: 2024-07-01
url: "https://www.djangobim.com"
repository-code: "https://github.com/starling-cloud/django-bim"
license: "Apache License, Version 2.0"
message: >-
  If you use Django BIM, please cite it using
  the metadata from this file.
type: software
authors:
  - given-names: Lars Bastiaan
    family-names: van Vianen
    email: lars@starling.studio
    affiliation: Starling Associates
    orcid: 'https://orcid.org/0000-0002-8790-8630'

GitHub Events

Total
  • Watch event: 3
  • Delete event: 1
  • Push event: 12
  • Pull request event: 1
Last Year
  • Watch event: 3
  • Delete event: 1
  • Push event: 12
  • Pull request event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 months
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 months
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 1
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 11 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
pypi.org: django-bim

A Django plugin to manage building data based on IFC

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 11 Last month
Rankings
Dependent packages count: 10.7%
Average: 35.4%
Dependent repos count: 60.1%
Maintainers (1)
starlingcloud
Last synced: 6 months ago

Dependencies

.github/workflows/deploy_docs.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/publish_package.yml actions
  • actions/checkout v4 composite
  • actions/checkout master composite
  • actions/create-release v1 composite
  • actions/download-artifact v4 composite
  • actions/setup-node v4 composite
  • actions/upload-artifact v4 composite
  • actions/upload-release-asset v1 composite
.devcontainer/Dockerfile docker
  • python 3.12-slim build
.devcontainer/docker-compose.yml docker
pyproject.toml pypi
  • pytest ^7.0 develop
  • Django ^4.0
  • python ^3.8