Rogii Solo.Comment¶

`Comment`¶
attribute well	Reference to the `Well` instance this `Comment` belongs to.
attribute comment_id	Unique identifier of the `Comment`.
attribute name	Name of the `Comment`.
property comment_boxes	Get `CommentBox` objects of the `Comment`.
method to_dict(get_converted)	Convert the `Comment` instance to a dictionary.
method to_df(get_converted)	Convert the `Comment` instance to a Pandas DataFrame.

`CommentBox`¶
attribute comment	Reference to the `Comment` instance this `CommentBox` belongs to.
attribute commentbox_id	Unique identifier of the `CommentBox`.
attribute text	Text of the `CommentBox`.
attribute anchor_md	Anchor MD of the `CommentBox`.
method to_dict(get_converted)	Convert the `CommentBox` instance to a dictionary.
method to_df(get_converted)	Convert the `CommentBox` instance to a Pandas DataFrame.

Module Contents¶

class Comment(well: rogii_solo.well.Well, **kwargs)¶

Bases: rogii_solo.base.BaseObject

Represent a Comment associated with a specific Well. Provides properties such as name and id.

Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')

# Get Comments of the Well
comments = well.comments

# Get a Comment name
comment = comments.find_by_name('Comment1')
print(comment.name)

# Get a Comment id
comment = comments.find_by_id('CommentID')
print(comment.comment_id)

well¶: Reference to the Well instance this Comment belongs to.

comment_id: str | None = None¶: Unique identifier of the Comment.

name: str | None = None¶: Name of the Comment.

property comment_boxes: rogii_solo.base.ObjectRepository[CommentBox]¶

Get CommentBox objects of the Comment.

Returns:: A CommentBox instance of the Comment.
Example:

from rogii_solo import SoloClient

client_id = ...  # Input your client ID
client_secret = ...  # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
comments = well.comments
comment = comments.find_by_name('Comment1')

# Get a CommentBox of the Comment
comment_box = comment.comment_boxes.find_by_id('CommentBoxID')
print(comment_box.to_dict())

to_dict(get_converted: bool = True) → Dict[str, Any]¶

Convert the Comment instance to a dictionary.

Returns:: Dictionary representation of the Comment.
Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
comments = well.comments
comment = comments.find_by_name('Comment1')

# Convert the Comment to a dictionary
comment_dict = comment.to_dict()
print(comment_dict)

to_df(get_converted: bool = True) → pandas.DataFrame¶

Convert the Comment instance to a Pandas DataFrame.

Returns:: DataFrame representation of the Comment.
Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
comments = well.comments
comment = comments.find_by_name('Comment1')

# Convert the Comment to a DataFrame
comment_df = comment.to_df()
print(comment_df)

class CommentBox(comment: Comment, **kwargs)¶

Bases: rogii_solo.base.BaseObject

Represent a CommentBox associated with a specific Comment. Provides properties such as text, anchor_md, and id.

Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')

# Get a CommentBox of the Comment
comments = well.comments
comment = comments.find_by_name('Comment1')
comment_box = comment.comment_boxes.find_by_id('CommentBoxID')

# Get a CommentBox id
comment_box_id = comment_box.commentbox_id
print(comment_box_id)

# Get a CommentBox anchor md
comment_box_anchor_md = comment_box.anchor_md
print(comment_box_anchor_md)

# Get a CommentBox text
comment_box_text = comment_box.text
print(comment_box_text)

comment¶: Reference to the Comment instance this CommentBox belongs to.

commentbox_id: str | None = None¶: Unique identifier of the CommentBox.

text: str | None = None¶: Text of the CommentBox.

anchor_md: float | None = None¶: Anchor MD of the CommentBox.

to_dict(get_converted: bool = True) → Dict[str, Any]¶

Convert the CommentBox instance to a dictionary.

Returns:: Dictionary representation of the CommentBox.
Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
comments = well.comments
comment = comments.find_by_name('Comment1')
comment_box = comment.comment_boxes.find_by_id('CommentBoxID')

# Convert the CommentBox to a dictionary
comment_box_dict = comment_box.to_dict()
print(comment_box_dict)

to_df(get_converted: bool = True) → pandas.DataFrame¶

Convert the CommentBox instance to a Pandas DataFrame.

Returns:: DataFrame representation of the CommentBox.
Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
well = project.wells.find_by_name('Well1')
comments = well.comments
comment = comments.find_by_name('Comment1')
comment_box = comment.comment_boxes.find_by_id('CommentBoxID')

# Convert the CommentBox to a DataFrame
comment_box_df = comment_box.to_df()
print(comment_box_df)